/usr/include/sbml/packages/comp/util/SBMLResolverRegistry.h is in libsbml5-dev 5.13.0+dfsg-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 | /**
* @file SBMLResolverRegistry.h
* @brief Definition of SBMLResolverRegistry, a registry of available resolvers.
* @author Frank Bergmann
*
* <!--------------------------------------------------------------------------
* This file is part of libSBML. Please visit http://sbml.org for more
* information about SBML, and the latest version of libSBML.
*
* Copyright (C) 2013-2016 jointly by the following organizations:
* 1. California Institute of Technology, Pasadena, CA, USA
* 2. EMBL European Bioinformatics Institute (EMBL-EBI), Hinxton, UK
* 3. University of Heidelberg, Heidelberg, Germany
*
* Copyright 2011-2012 jointly by the following organizations:
* 1. California Institute of Technology, Pasadena, CA, USA
* 2. EMBL European Bioinformatics Institute (EMBL-EBI), Hinxton, UK
*
* This library is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation. A copy of the license agreement is provided
* in the file named "LICENSE.txt" included with this software distribution
* and also available online as http://sbml.org/software/libsbml/license.html
* ------------------------------------------------------------------------ -->
*
* @class SBMLResolverRegistry
* @sbmlbrief{comp} Registry of all SBML resolvers.
*
* @htmlinclude libsbml-facility-only-warning.html
*
* LibSBML provides facilities for resolving SBML documents in various ways
* from a given URI. Resolvers are implemented as objects derived from the
* class SBMLResolver.
*
* The resolver registry maintains a list of known resolvers and provides
* methods for discovering them. It is implemented as a singleton object of
* class SBMLResolverRegistry. Callers can use the method
* SBMLResolverRegistry::getNumResolvers() to find out how many resolvers are
* registered, then use SBMLResolverRegistry::getResolverByIndex(@if java
* int@endif) to iterate over each one;
*
* @see SBMLFileResolver
*/
#ifndef SBMLResolverRegistry_h
#define SBMLResolverRegistry_h
#include <sbml/common/sbmlfwd.h>
#include <sbml/packages/comp/util/SBMLResolver.h>
#ifdef __cplusplus
#include <map>
#include <vector>
#include <string>
#include <set>
LIBSBML_CPP_NAMESPACE_BEGIN
class LIBSBML_EXTERN SBMLResolverRegistry
{
public:
/**
* Returns the singleton instance for the resolver registry.
*
* Prior to using the registry, callers have to obtain a copy of the
* registry. This static method provides the means for doing that.
*
* @return the singleton for the resolver registry.
*/
static SBMLResolverRegistry& getInstance();
/**
* Adds the given resolver to the registry of SBML resolvers.
*
* @param resolver the resolver to add to the registry.
*
* @copydetails doc_returns_success_code
* @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
* @li @sbmlconstant{LIBSBML_INVALID_OBJECT, OperationReturnValues_t}
*/
int addResolver (const SBMLResolver* resolver);
/**
* Adds the given SBMLDocument* to the registry of SBML documents that will need to be deleted.
*
* When calculating reference cycles, sometimes we need SBML Documents to persist, but nobody
* else owns them directly. We hand them to the registry here so they can be cleaned up
*
* @param doc the SBML Document to add to the registry.
*
* @copydetails doc_returns_success_code
* @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
* @li @sbmlconstant{LIBSBML_INVALID_OBJECT, OperationReturnValues_t}
*/
int addOwnedSBMLDocument (const SBMLDocument* doc);
/**
* Removes the resolver with the given index.
*
* @param index the index of the resolver to be removed
*
* @copydetails doc_returns_success_code
* @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
* @li @sbmlconstant{LIBSBML_INVALID_OBJECT, OperationReturnValues_t}
*/
int removeResolver(int index);
/**
* Returns the resolver with the given index number.
*
* Resolvers are given arbitrary index numbers by the registry. Callers
* can use the method SBMLResolverRegistry::getNumResolvers() to find
* out how many resolvers are registered, then use this method to
* iterate over the list and obtain each one in turn.
*
* @param index the zero-based index of the resolver to fetch.
*
* @return the resolver with the given index number, or @c NULL if the
* number is less than @c 0 or there is no resolver at the given index
* position.
*/
SBMLResolver* getResolverByIndex(int index) const;
/**
* Returns the number of resolvers known by the registry.
*
* @return the number of registered resolvers.
*
* @see getResolverByIndex(@if java int@endif)
*/
int getNumResolvers() const;
/**
* Destructor
*/
virtual ~SBMLResolverRegistry();
/**
* Resolves the document for the given URI.
*
* @param uri the URI to the target document
* @param baseUri base URI, in case the URI is a relative one
*
* @return the document, if this resolver can resolve the document or NULL.
*/
virtual SBMLDocument* resolve(const std::string &uri, const std::string& baseUri="") const;
/**
* Resolves the full URI for the given URI without actually reading the
* document.
*
* @param uri the URI to the target document
* @param baseUri base URI, in case the URI is a relative one
*
* @return the full URI to the document, if this resolver can resolve the document or NULL.
*/
virtual SBMLUri* resolveUri(const std::string &uri, const std::string& baseUri="") const;
/**
* deletes the static resolver registry instance
*/
static void deleteResolerRegistryInstance();
protected:
/** @cond doxygenLibsbmlInternal */
/**
* protected constructor, use the getInstance() method to access the registry.
*/
SBMLResolverRegistry();
/** @endcond */
protected:
/** @cond doxygenLibsbmlInternal */
std::vector<const SBMLResolver*> mResolvers;
std::set<const SBMLDocument*> mOwnedDocuments;
static SBMLResolverRegistry* mInstance;
/** @endcond */
};
LIBSBML_CPP_NAMESPACE_END
#endif /* __cplusplus */
#ifndef SWIG
LIBSBML_CPP_NAMESPACE_BEGIN
BEGIN_C_DECLS
END_C_DECLS
LIBSBML_CPP_NAMESPACE_END
#endif /* !SWIG */
#endif /* !SBMLResolverRegistry_h */
|