diff --git a/src/orc/ResourceCompiler.h b/src/orc/ResourceCompiler.h index 1fb3d89e1abd4265156e8a0fefb52c5219fa9162..a82e3b780dbd4932b6b70ad7faa95743c1b30ef2 100644 --- a/src/orc/ResourceCompiler.h +++ b/src/orc/ResourceCompiler.h @@ -39,7 +39,7 @@ using namespace std; /** * \brief Helper class that converts binary resources into source code ready for compilation - * + * * This "compiler" takes a resource specification file, opens and loads the physical * files and converts their contents into normal C/C++ source code. The source code * comprises three arrays which can be subsequently compiled into object code which is @@ -52,16 +52,16 @@ using namespace std; * - <code>PhysicalResourceName</code> is the actual file name of the resource * - Lines starting with # are treated as comments * - Empty lines are ignored - * + * * As you can see the logical and the physical (file) resource name are delimited by the pipe (|) character. * The logical resource name will be used again later. It is the identifier used to request a resource via - * ResourceFactory::createInstance() - * + * ResourceFactory::createInstance() + * * \see ResourceFactory * \see ResourceFactory::c_ResourceIdentifiers * \see ResourceFactory::c_ResourceIndex * \see ResourceFactory::c_ResourceStorage - * + * * \author Oliver Bock\n * Max-Planck-Institute for Gravitational Physics\n * Hannover, Germany @@ -71,57 +71,57 @@ class ResourceCompiler public: /** * \brief Constructor - * + * * \param inputFilename Name of the resource specification file (source, \c *.orc) * \param outputFilename Name of the converted recources file (destination, \c *.cpp) */ ResourceCompiler(const string inputFilename, const string outputFilename); - + /// Destructor virtual ~ResourceCompiler(); - + /** * \brief Converts the specified resources into the specified source code file - * + * * It iterates over all resources found in the local cache and stores their data * and meta information as source code in the destination file. Thus parseInputFile() * and loadBinaryData() have to be called first for this to work. - * + * * \see parseInputFile * \see loadBinaryData */ void compile(); - + private: /** * \brief Parses the specified input file - * + * * After validating the resource specification file its contents are * stored for later use. - * + * * \see loadBinaryData */ void parseInputFile(); - + /** * \brief Loads binary resource file data into the local cache - * + * * This methods tries to open all resource files found by loadBinaryData() * and copies their binary data into the local cache. - * + * * \see parseInputFile */ void loadBinaryData(); - + /// Path and filename of the resource specification file (source) string m_ResourceSpecFile; - + /// Path and filename of the converted source code file (destination) string m_ResourceCodeFile; - + /// Mapping between logical and physical resource names map<string, string> m_ResourceFileMap; - + /// %Resource cache (identified by logical resource name) map<string, vector<unsigned char> > m_ResourceDataMap; };