* The contents of this file are subject to the LGPL License, Version 3.0.

* Copyright 2014, The University of Manchester

*

* This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

* This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.

* You should have received a copy of the GNU General Public License along with this program.  If not, see http://www.gnu.org/licenses/.

*

* Alternatively, the contents of this file may be used under the terms of the Apache License, Version 2.0 in which case, the provisions of the Apache License Version 2.0 are applicable instead of those above.

* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

* http://www.apache.org/licenses/LICENSE-2.0

* Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */

* A parser for the Manchester OWL Syntax. All properties must be defined before

* they are used. For example, consider the restriction hasPart some Leg. The

* parser must know in advance whether or not hasPart is an object property or a

* data property so that Leg gets parsed correctly. In a tool, such as an

* editor, it is expected that hasPart will already exists as either a data

* property or an object property. If a complete ontology is being parsed, it is

* expected that hasPart will have been defined at the top of the file before it

* is used in any class expressions or property assertions (e.g. ObjectProperty:

* hasPart)

*

* @author Matthew Horridge, The University Of Manchester, Bio-Health

*         Informatics Group

* @since 2.2.0

*/

    // This parser was built by hand! After struggling with terrible

    // error messages produced by ANTLR (or JavaCC) I decides to construct

    // this parser by hand. The error messages that this parser generates

    // are specific to the Manchester OWL Syntax and are such that it should

    // be easy to use this parser in tools such as editors.

    @Nonnull

    private Provider<OWLOntologyLoaderConfiguration> configProvider;

    @SuppressWarnings("null")

    @Nonnull

    private Optional<OWLOntologyLoaderConfiguration> config = Optional.absent();

    protected OWLDataFactory dataFactory;

    private List<Token> tokens;

    private int tokenIndex;

    private OWLEntityChecker owlEntityChecker;

    private OWLOntologyChecker owlOntologyChecker = new OWLOntologyChecker() {

        @Nullable

        @Override

        public OWLOntology getOntology(String name) {

            return null;

        }

    };

    @Nonnull

    protected final Set<String> classNames = new HashSet<>();

    @Nonnull

    protected final Set<String> objectPropertyNames = new HashSet<>();

    @Nonnull

    protected final Set<String> dataPropertyNames = new HashSet<>();

    @Nonnull

    protected final Set<String> individualNames = new HashSet<>();

    @Nonnull

    protected final Set<String> dataTypeNames = new HashSet<>();

    @Nonnull

    protected final Set<String> annotationPropertyNames = new HashSet<>();

    @Nonnull

    private final Map<String, SWRLBuiltInsVocabulary> ruleBuiltIns = new TreeMap<>();

    @Nonnull

    protected DefaultPrefixManager pm = new DefaultPrefixManager();

    @Nonnull

    protected final Set<ManchesterOWLSyntax> potentialKeywords = new HashSet<>();

    private OWLOntology defaultOntology;

    private final boolean allowEmptyFrameSections = false;

    private final Map<ManchesterOWLSyntax, AnnotatedListItemParser<OWLDataProperty, ?>> dataPropertyFrameSections = new EnumMap<>(

            ManchesterOWLSyntax.class);

    /**

     * @param configurationProvider

     *        configuration provider

     * @param dataFactory

     *        dataFactory

     */

    @Inject

    public ManchesterOWLSyntaxParserImpl(

            @Nonnull Provider<OWLOntologyLoaderConfiguration> configurationProvider,

            @Nonnull OWLDataFactory dataFactory) {

        configProvider = configurationProvider;

        this.dataFactory = dataFactory;

        pm.setPrefix("rdf:", Namespaces.RDF.toString());

        pm.setPrefix("rdfs:", Namespaces.RDFS.toString());

        pm.setPrefix("owl:", Namespaces.OWL.toString());

        pm.setPrefix("dc:", DublinCoreVocabulary.NAME_SPACE);

        NamespaceUtil u = new NamespaceUtil();

        initialiseClassFrameSections();

        initialiseObjectPropertyFrameSections();

        initialiseDataPropertyFrameSections();

        initialiseAnnotationPropertyFrameSections();

        initialiseIndividualFrameSections();

        for (XSDVocabulary v : XSDVocabulary.values()) {

            dataTypeNames.add(v.getIRI().toString());

            dataTypeNames.add(v.getIRI().toQuotedString());

            dataTypeNames.add(v.getPrefixedName());

        }

        dataTypeNames.add(OWLRDFVocabulary.RDFS_LITERAL.getPrefixedName());

        dataTypeNames.add(OWLRDFVocabulary.RDF_XML_LITERAL.getShortForm());

        dataTypeNames.add(OWLRDFVocabulary.RDF_XML_LITERAL.getPrefixedName());

        for (IRI iri : OWLRDFVocabulary.BUILT_IN_ANNOTATION_PROPERTY_IRIS) {

            String string = iri.toString();

            String ns = XMLUtils.getNCNamePrefix(string);

            String fragment = XMLUtils.getNCNameSuffix(string);

            annotationPropertyNames.add(u.getPrefix(ns) + ':'

                    + (fragment != null ? fragment : ""));

        }

        owlEntityChecker = new DefaultEntityChecker();

        for (SWRLBuiltInsVocabulary v : SWRLBuiltInsVocabulary.values()) {

            ruleBuiltIns.put(v.getShortForm(), v);

            ruleBuiltIns.put(v.getIRI().toQuotedString(), v);

        }

    }

    @Override

    @SuppressWarnings("null")

    @Nonnull

    public OWLOntologyLoaderConfiguration getOntologyLoaderConfiguration() {

        if (config.isPresent()) {

            return config.get();

        }

        config = Optional.of(configProvider.get());

        return config.get();

    }

    @Override

    public void setOntologyLoaderConfigurationProvider(

            Provider<OWLOntologyLoaderConfiguration> provider) {

        configProvider = provider;

    }

    @SuppressWarnings("null")

    @Override

    public void setOntologyLoaderConfiguration(

            OWLOntologyLoaderConfiguration config) {

        this.config = Optional.fromNullable(config);

    }

    @Override

    public void setStringToParse(String s) {

        tokens = new ArrayList<>();