Skip to content

Commit

Permalink
libdeng2: Updated code style for consistency
Browse files Browse the repository at this point in the history 
Namespaces are not indented.
  • Loading branch information
@skyjake
skyjake committed Jan 6, 2013
1 parent f2a3793 commit 18dafbe
Show file tree
Hide file tree
Showing 57 changed files with 5,382 additions and 5,327 deletions.
355 changes: 178 additions & 177 deletions doomsday/libdeng2/include/de/core/commandline.h
View file
Expand Up @@ -30,184 +30,185 @@
#include "../String"
#include "../NativePath"

namespace de
namespace de {

/**
* Stores and provides access to the command line arguments passed
* to an application at launch.
*
* @ingroup core
*/
class DENG2_PUBLIC CommandLine
{
public:
/// Tried to access an argument that does not exist. @ingroup errors
DENG2_ERROR(OutOfRangeError);

/// Execution of the command line failed. @ingroup errors
DENG2_ERROR(ExecuteError);

public:
CommandLine();

/**
* Stores and provides access to the command line arguments passed
* to an application at launch.
*
* @ingroup core
*/
class DENG2_PUBLIC CommandLine
{
public:
/// Tried to access an argument that does not exist. @ingroup errors
DENG2_ERROR(OutOfRangeError);

/// Execution of the command line failed. @ingroup errors
DENG2_ERROR(ExecuteError);

public:
CommandLine();

/**
* Constructs a CommandLine out of a list of strings. The argument
* strings that begin with a @@ character are parsed as response files
* the rest are used without modification.
*
* @param args Arguments to use.
*/
CommandLine(QStringList const &args);

CommandLine(CommandLine const &other);

virtual ~CommandLine();

/**
* Returns the native path where the command line was started in.
* @return Native startup location.
*/
NativePath startupPath();

/**
* Returns the number of arguments. This includes the program name, which
* is the first argument in the list.
*/
dint count() const;

void clear();

/**
* Appends a new argument to the list of arguments.
*
* @param arg Argument to append.
*/
void append(String const &arg);

/**
* Inserts a new argument to the list of arguments at index @a pos.
*
* @param pos Index at which the new argument will be at.
* @param arg Argument to insert.
*/
void insert(duint pos, String const &arg);

/**
* Removes an argument by index.
*
* @param pos Index of argument to remove.
*/
void remove(duint pos);

/**
* Checks whether @a arg is in the arguments. Since the first argument is
* the program name, it is not included in the search.
*
* @param arg Argument to look for. Don't use aliases here.
* @param count Number of parameters (non-option arguments) that follow
* the located argument.
*
* @see isOption()
*
* @return Index of the argument, if found. Otherwise zero.
*/
dint check(String const &arg, dint count = 0) const;

/**
* Gets the parameter for an argument.
*
* @param arg Argument to look for. Don't use aliases here. Defines
* aliases will be checked for matches.
* @param param The parameter is returned here, if found.
*
* @return @c true, if parameter was successfully returned.
* Otherwise @c false, in which case @a param is not modified.
*/
bool getParameter(String const &arg, String &param) const;

/**
* Determines whether @a arg exists in the list of arguments.
*
* @param arg Argument to look for. Don't use aliases here.
*
* @return Number of times @a arg is found in the arguments.
*/
dint has(String const &arg) const;

/**
* Determines whether an argument is an option, i.e., it begins with a hyphen.
*/
bool isOption(duint pos) const;

/**
* Determines whether an argument is an option, i.e., it begins with a hyphen.
*/
static bool isOption(String const &arg);

String at(duint pos) const;

/**
* Returns a list of pointers to the arguments. The list contains
* count() strings and is NULL-terminated.
*/
char const *const *argv() const;

/**
* Converts the argument at position @a pos into an absolute native path.
* Relative paths are converted relative to the directory that was
* current at the time the CommandLine was created.
*
* @param pos Argument index.
*/
void makeAbsolutePath(duint pos);

/**
* Reads a native file and parses its contents using parse().
*
* @param nativePath File to parse.
*/
void parseResponseFile(NativePath const &nativePath);

/**
* Breaks down a single string containing arguments.
*
* Examples of behavior:
* - -cmd "echo ""this is a command""" => [-cmd] [echo "this is a command"]
* - Hello" My"Friend => [Hello MyFriend]
* - @@test.rsp [reads contents of test.rsp]
* - <tt>@@\\"Program Files"\\test.rsp</tt> [reads contents of <tt>"\Program Files\test.rsp"</tt>]
*
* @param cmdLine String containing the arguments.
*/
void parse(String const &cmdLine);

/**
* Defines a new alias for a full argument.
*
* @param full The full argument, e.g., "--help"
* @param alias Alias for the full argument, e.g., "-h"
*/
void alias(String const &full, String const &alias);

/**
* @return @c true, iff the two parameters are equivalent according to
* the abbreviations.
*/
bool matches(String const &full, String const &fullOrAlias) const;

/**
* Spawns a new process using the command line. The first argument
* specifies the file name of the executable. Returns immediately
* after the process has been started.
*
* @return @c true if successful, otherwise @c false.
*/
bool execute() const;

private:
struct Instance;
Instance *d;
};
}
* Constructs a CommandLine out of a list of strings. The argument
* strings that begin with a @@ character are parsed as response files
* the rest are used without modification.
*
* @param args Arguments to use.
*/
CommandLine(QStringList const &args);

CommandLine(CommandLine const &other);

virtual ~CommandLine();

/**
* Returns the native path where the command line was started in.
* @return Native startup location.
*/
NativePath startupPath();

/**
* Returns the number of arguments. This includes the program name, which
* is the first argument in the list.
*/
dint count() const;

void clear();

/**
* Appends a new argument to the list of arguments.
*
* @param arg Argument to append.
*/
void append(String const &arg);

/**
* Inserts a new argument to the list of arguments at index @a pos.
*
* @param pos Index at which the new argument will be at.
* @param arg Argument to insert.
*/
void insert(duint pos, String const &arg);

/**
* Removes an argument by index.
*
* @param pos Index of argument to remove.
*/
void remove(duint pos);

/**
* Checks whether @a arg is in the arguments. Since the first argument is
* the program name, it is not included in the search.
*
* @param arg Argument to look for. Don't use aliases here.
* @param count Number of parameters (non-option arguments) that follow
* the located argument.
*
* @see isOption()
*
* @return Index of the argument, if found. Otherwise zero.
*/
dint check(String const &arg, dint count = 0) const;

/**
* Gets the parameter for an argument.
*
* @param arg Argument to look for. Don't use aliases here. Defines
* aliases will be checked for matches.
* @param param The parameter is returned here, if found.
*
* @return @c true, if parameter was successfully returned.
* Otherwise @c false, in which case @a param is not modified.
*/
bool getParameter(String const &arg, String &param) const;

/**
* Determines whether @a arg exists in the list of arguments.
*
* @param arg Argument to look for. Don't use aliases here.
*
* @return Number of times @a arg is found in the arguments.
*/
dint has(String const &arg) const;

/**
* Determines whether an argument is an option, i.e., it begins with a hyphen.
*/
bool isOption(duint pos) const;

/**
* Determines whether an argument is an option, i.e., it begins with a hyphen.
*/
static bool isOption(String const &arg);

String at(duint pos) const;

/**
* Returns a list of pointers to the arguments. The list contains
* count() strings and is NULL-terminated.
*/
char const *const *argv() const;

/**
* Converts the argument at position @a pos into an absolute native path.
* Relative paths are converted relative to the directory that was
* current at the time the CommandLine was created.
*
* @param pos Argument index.
*/
void makeAbsolutePath(duint pos);

/**
* Reads a native file and parses its contents using parse().
*
* @param nativePath File to parse.
*/
void parseResponseFile(NativePath const &nativePath);

/**
* Breaks down a single string containing arguments.
*
* Examples of behavior:
* - -cmd "echo ""this is a command""" => [-cmd] [echo "this is a command"]
* - Hello" My"Friend => [Hello MyFriend]
* - @@test.rsp [reads contents of test.rsp]
* - <tt>@@\\"Program Files"\\test.rsp</tt> [reads contents of <tt>"\Program Files\test.rsp"</tt>]
*
* @param cmdLine String containing the arguments.
*/
void parse(String const &cmdLine);

/**
* Defines a new alias for a full argument.
*
* @param full The full argument, e.g., "--help"
* @param alias Alias for the full argument, e.g., "-h"
*/
void alias(String const &full, String const &alias);

/**
* @return @c true, iff the two parameters are equivalent according to
* the abbreviations.
*/
bool matches(String const &full, String const &fullOrAlias) const;

/**
* Spawns a new process using the command line. The first argument
* specifies the file name of the executable. Returns immediately
* after the process has been started.
*
* @return @c true if successful, otherwise @c false.
*/
bool execute() const;

private:
struct Instance;
Instance *d;
};

} // namespace de

#endif /* LIBDENG2_COMMANDLINE_H */

0 comments on commit 18dafbe

Please sign in to comment.