Skip to content
GitLab
Menu
Projects
Groups
Snippets
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
Oliver Behnke
graphicsframework
Commits
2b90f3e8
Commit
2b90f3e8
authored
May 27, 2009
by
Oliver Bock
Browse files
Remove trailing whitespaces
parent
0bda4a39
Changes
1
Hide whitespace changes
Inline
Side-by-side
src/orc/ResourceCompiler.h
View file @
2b90f3e8
...
@@ -39,7 +39,7 @@ using namespace std;
...
@@ -39,7 +39,7 @@ using namespace std;
/**
/**
* \brief Helper class that converts binary resources into source code ready for compilation
* \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
* 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
* 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
* comprises three arrays which can be subsequently compiled into object code which is
...
@@ -52,16 +52,16 @@ using namespace std;
...
@@ -52,16 +52,16 @@ using namespace std;
* - <code>PhysicalResourceName</code> is the actual file name of the resource
* - <code>PhysicalResourceName</code> is the actual file name of the resource
* - Lines starting with # are treated as comments
* - Lines starting with # are treated as comments
* - Empty lines are ignored
* - Empty lines are ignored
*
*
* As you can see the logical and the physical (file) resource name are delimited by the pipe (|) character.
* 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
* 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
* \see ResourceFactory::c_ResourceIdentifiers
* \see ResourceFactory::c_ResourceIdentifiers
* \see ResourceFactory::c_ResourceIndex
* \see ResourceFactory::c_ResourceIndex
* \see ResourceFactory::c_ResourceStorage
* \see ResourceFactory::c_ResourceStorage
*
*
* \author Oliver Bock\n
* \author Oliver Bock\n
* Max-Planck-Institute for Gravitational Physics\n
* Max-Planck-Institute for Gravitational Physics\n
* Hannover, Germany
* Hannover, Germany
...
@@ -71,57 +71,57 @@ class ResourceCompiler
...
@@ -71,57 +71,57 @@ class ResourceCompiler
public:
public:
/**
/**
* \brief Constructor
* \brief Constructor
*
*
* \param inputFilename Name of the resource specification file (source, \c *.orc)
* \param inputFilename Name of the resource specification file (source, \c *.orc)
* \param outputFilename Name of the converted recources file (destination, \c *.cpp)
* \param outputFilename Name of the converted recources file (destination, \c *.cpp)
*/
*/
ResourceCompiler
(
const
string
inputFilename
,
const
string
outputFilename
);
ResourceCompiler
(
const
string
inputFilename
,
const
string
outputFilename
);
/// Destructor
/// Destructor
virtual
~
ResourceCompiler
();
virtual
~
ResourceCompiler
();
/**
/**
* \brief Converts the specified resources into the specified source code file
* \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
* 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 meta information as source code in the destination file. Thus parseInputFile()
* and loadBinaryData() have to be called first for this to work.
* and loadBinaryData() have to be called first for this to work.
*
*
* \see parseInputFile
* \see parseInputFile
* \see loadBinaryData
* \see loadBinaryData
*/
*/
void
compile
();
void
compile
();
private:
private:
/**
/**
* \brief Parses the specified input file
* \brief Parses the specified input file
*
*
* After validating the resource specification file its contents are
* After validating the resource specification file its contents are
* stored for later use.
* stored for later use.
*
*
* \see loadBinaryData
* \see loadBinaryData
*/
*/
void
parseInputFile
();
void
parseInputFile
();
/**
/**
* \brief Loads binary resource file data into the local cache
* \brief Loads binary resource file data into the local cache
*
*
* This methods tries to open all resource files found by loadBinaryData()
* This methods tries to open all resource files found by loadBinaryData()
* and copies their binary data into the local cache.
* and copies their binary data into the local cache.
*
*
* \see parseInputFile
* \see parseInputFile
*/
*/
void
loadBinaryData
();
void
loadBinaryData
();
/// Path and filename of the resource specification file (source)
/// Path and filename of the resource specification file (source)
string
m_ResourceSpecFile
;
string
m_ResourceSpecFile
;
/// Path and filename of the converted source code file (destination)
/// Path and filename of the converted source code file (destination)
string
m_ResourceCodeFile
;
string
m_ResourceCodeFile
;
/// Mapping between logical and physical resource names
/// Mapping between logical and physical resource names
map
<
string
,
string
>
m_ResourceFileMap
;
map
<
string
,
string
>
m_ResourceFileMap
;
/// %Resource cache (identified by logical resource name)
/// %Resource cache (identified by logical resource name)
map
<
string
,
vector
<
unsigned
char
>
>
m_ResourceDataMap
;
map
<
string
,
vector
<
unsigned
char
>
>
m_ResourceDataMap
;
};
};
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment