Skip to content

Commit

Permalink
libdeng1: Updated code style for consistency
Browse files Browse the repository at this point in the history
  • Loading branch information
danij-deng committed Jan 7, 2013
1 parent be8a156 commit 1250b5e
Show file tree
Hide file tree
Showing 13 changed files with 1,812 additions and 1,812 deletions.
864 changes: 432 additions & 432 deletions doomsday/engine/include/filesys/fs_main.h

Large diffs are not rendered by default.

156 changes: 78 additions & 78 deletions doomsday/engine/include/filesys/manifest.h
Expand Up @@ -31,88 +31,88 @@
#include <de/String>
#include "api_uri.h"

namespace de
namespace de {

/**
* Stores high-level metadata for and arbitrates/facilitates
* access to the associated "physical" resource.
*
* @ingroup core
*/
class Manifest
{
public:
/**
* @param rClass Class for the associated resource.
* @param fFlags @ref fileFlags
* @param name An expected name for the associated file.
*/
Manifest(resourceclassid_t rClass, int fFlags, String* name = 0);
~Manifest();

/// @return Class of the associated resource.
resourceclassid_t resourceClass() const;

/// @return Flags for this file.
int fileFlags() const;

/// @return List of "identity keys" used to identify the file.
QStringList const& identityKeys() const;

/// @return List of names for the associated file.
QStringList const& names() const;

/**
* Attempt to locate this file by systematically resolving and then
* checking each search path.
*/
Manifest& locateFile();

/**
* "Forget" the currently located file if one has been found.
*/
Manifest& forgetFile();

/**
* Attempt to resolve a path to (and maybe locate) this file.
*
* @param tryLocate @c true= Attempt to locate the file now.
*
* @return Path to the found file or an empty string.
*
* @see locateFile()
*/
String const& resolvedPath(bool tryLocate = true);

/**
* Add a new file segment identity key to the list for this manifest.
*
* @param newIdentityKey New identity key (e.g., a lump/file name).
* @param didAdd If not @c =0, the outcome will be written here.
*/
Manifest& addIdentityKey(String newIdentityKey, bool* didAdd = 0);

/**
* Add a new file name to the list of names for this manifest.
*
* @param newName New name for this file. Newer names have precedence.
* @param didAdd If not @c =0, the outcome will be written here.
*/
Manifest& addName(String newName, bool* didAdd = 0);

/**
* Stores high-level metadata for and arbitrates/facilitates
* access to the associated "physical" resource.
* Print information about a file to the console.
*
* @ingroup core
* @param manifest Manifest for the file.
* @param showStatus @c true = print loaded/located status for the
* associated file.
*/
class Manifest
{
public:
/**
* @param rClass Class for the associated resource.
* @param fFlags @ref fileFlags
* @param name An expected name for the associated file.
*/
Manifest(resourceclassid_t rClass, int fFlags, String* name = 0);
~Manifest();

/// @return Class of the associated resource.
resourceclassid_t resourceClass() const;

/// @return Flags for this file.
int fileFlags() const;

/// @return List of "identity keys" used to identify the file.
QStringList const& identityKeys() const;

/// @return List of names for the associated file.
QStringList const& names() const;

/**
* Attempt to locate this file by systematically resolving and then
* checking each search path.
*/
Manifest& locateFile();

/**
* "Forget" the currently located file if one has been found.
*/
Manifest& forgetFile();

/**
* Attempt to resolve a path to (and maybe locate) this file.
*
* @param tryLocate @c true= Attempt to locate the file now.
*
* @return Path to the found file or an empty string.
*
* @see locateFile()
*/
String const& resolvedPath(bool tryLocate = true);

/**
* Add a new file segment identity key to the list for this manifest.
*
* @param newIdentityKey New identity key (e.g., a lump/file name).
* @param didAdd If not @c =0, the outcome will be written here.
*/
Manifest& addIdentityKey(String newIdentityKey, bool* didAdd = 0);

/**
* Add a new file name to the list of names for this manifest.
*
* @param newName New name for this file. Newer names have precedence.
* @param didAdd If not @c =0, the outcome will be written here.
*/
Manifest& addName(String newName, bool* didAdd = 0);

/**
* Print information about a file to the console.
*
* @param manifest Manifest for the file.
* @param showStatus @c true = print loaded/located status for the
* associated file.
*/
static void consolePrint(Manifest& manifest, bool showStatus = true);

private:
struct Instance;
Instance* d;
};
static void consolePrint(Manifest& manifest, bool showStatus = true);

private:
struct Instance;
Instance* d;
};

} // namespace de

Expand Down

0 comments on commit 1250b5e

Please sign in to comment.