Skip to content

codeStyle app folder #338

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
lukaspj wants to merge 1 commit into
base: Preview4_0
Choose a base branch
from
Open

codeStyle app folder #338

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion Engine/source/app/auth.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,8 @@ class Auth2Certificate
/// Formerly contained data indicating whether a user is valid.
struct AuthInfo
{
enum {
enum
{
MaxNameLen = 31,
};

Expand Down
158 changes: 79 additions & 79 deletions Engine/source/app/badWordFilter.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,15 +30,15 @@

MODULE_BEGIN( BadWordFilter )

MODULE_INIT
{
BadWordFilter::create();
}
MODULE_SHUTDOWN
{
BadWordFilter::destroy();
}
MODULE_INIT
{
BadWordFilter::create();
}

MODULE_SHUTDOWN
{
BadWordFilter::destroy();
}

MODULE_END;

Expand All @@ -63,9 +63,9 @@ BadWordFilter::~BadWordFilter()

void BadWordFilter::create()
{
Con::addVariable("pref::enableBadWordFilter", TypeBool, &filteringEnabled,
"@brief If true, the bad word filter will be enabled.\n\n"
"@ingroup Game");
Con::addVariable("pref::enableBadWordFilter", TypeBool, &filteringEnabled,
"@brief If true, the bad word filter will be enabled.\n\n"
"@ingroup Game");
gBadWordFilter = new BadWordFilter;
gBadWordFilter->addBadWord("shit");
gBadWordFilter->addBadWord("fuck");
Expand Down Expand Up @@ -229,55 +229,55 @@ bool BadWordFilter::containsBadWords(const char *cstring)
}

DefineEngineFunction(addBadWord, bool, (const char* badWord),,
"@brief Add a string to the bad word filter\n\n"
"@brief Add a string to the bad word filter\n\n"

"The bad word filter is a table containing words which will not be "
"displayed in chat windows. Instead, a designated replacement string will be displayed. "
"There are already a number of bad words automatically defined.\n\n"
"The bad word filter is a table containing words which will not be "
"displayed in chat windows. Instead, a designated replacement string will be displayed. "
"There are already a number of bad words automatically defined.\n\n"

"@param badWord Exact text of the word to restrict.\n"
"@return True if word was successfully added, false if the word or a subset of it already exists in the table\n"
"@param badWord Exact text of the word to restrict.\n"
"@return True if word was successfully added, false if the word or a subset of it already exists in the table\n"

"@see filterString()\n\n"
"@see filterString()\n\n"

"@tsexample\n"
"// In this game, \"Foobar\" is banned\n"
"%badWord = \"Foobar\";\n\n"
"// Returns true, word was successfully added\n"
"addBadWord(%badWord);\n\n"
"// Returns false, word has already been added\n"
"addBadWord(\"Foobar\");"
"@endtsexample\n"
"@tsexample\n"
"// In this game, \"Foobar\" is banned\n"
"%badWord = \"Foobar\";\n\n"
"// Returns true, word was successfully added\n"
"addBadWord(%badWord);\n\n"
"// Returns false, word has already been added\n"
"addBadWord(\"Foobar\");"
"@endtsexample\n"

"@ingroup Game")
"@ingroup Game")
{
return gBadWordFilter->addBadWord(badWord);
}

DefineEngineFunction(filterString, const char *, (const char* baseString, const char* replacementChars), (nullAsType<const char*>(), nullAsType<const char*>()),
"@brief Replaces the characters in a string with designated text\n\n"
"@brief Replaces the characters in a string with designated text\n\n"

"Uses the bad word filter to determine which characters within the string will be replaced.\n\n"
"Uses the bad word filter to determine which characters within the string will be replaced.\n\n"

"@param baseString The original string to filter.\n"
"@param replacementChars A string containing letters you wish to swap in the baseString.\n"
"@return The new scrambled string \n"
"@param baseString The original string to filter.\n"
"@param replacementChars A string containing letters you wish to swap in the baseString.\n"
"@return The new scrambled string \n"

"@see addBadWord()\n"
"@see containsBadWords()\n"
"@see addBadWord()\n"
"@see containsBadWords()\n"

"@tsexample\n"
"// Create the base string, can come from anywhere\n"
"%baseString = \"Foobar\";\n\n"
"// Create a string of random letters\n"
"%replacementChars = \"knqwrtlzs\";\n\n"
"// Filter the string\n"
"%newString = filterString(%baseString, %replacementChars);\n\n"
"// Print the new string to console\n"
"echo(%newString);"
"@endtsexample\n"
"@tsexample\n"
"// Create the base string, can come from anywhere\n"
"%baseString = \"Foobar\";\n\n"
"// Create a string of random letters\n"
"%replacementChars = \"knqwrtlzs\";\n\n"
"// Filter the string\n"
"%newString = filterString(%baseString, %replacementChars);\n\n"
"// Print the new string to console\n"
"echo(%newString);"
"@endtsexample\n"

"@ingroup Game")
"@ingroup Game")
{
const char *replaceStr = NULL;

Expand All @@ -294,39 +294,39 @@ DefineEngineFunction(filterString, const char *, (const char* baseString, const
}

DefineEngineFunction(containsBadWords, bool, (const char* text),,
"@brief Checks to see if text is a bad word\n\n"

"The text is considered to be a bad word if it has been added to the bad word filter.\n\n"

"@param text Text to scan for bad words\n"
"@return True if the text has bad word(s), false if it is clean\n"

"@see addBadWord()\n"
"@see filterString()\n"

"@tsexample\n"
"// In this game, \"Foobar\" is banned\n"
"%badWord = \"Foobar\";\n\n"
"// Add a banned word to the bad word filter\n"
"addBadWord(%badWord);\n\n"
"// Create the base string, can come from anywhere like user chat\n"
"%userText = \"Foobar\";\n\n"
"// Create a string of random letters\n"
"%replacementChars = \"knqwrtlzs\";\n\n"
"// If the text contains a bad word, filter it before printing\n"
"// Otherwise print the original text\n"
"if(containsBadWords(%userText))\n"
"{\n"
" // Filter the string\n"
" %filteredText = filterString(%userText, %replacementChars);\n\n"
" // Print filtered text\n"
" echo(%filteredText);\n"
"}\n"
"else\n"
" echo(%userText);\n\n"
"@endtsexample\n"

"@ingroup Game")
"@brief Checks to see if text is a bad word\n\n"

"The text is considered to be a bad word if it has been added to the bad word filter.\n\n"

"@param text Text to scan for bad words\n"
"@return True if the text has bad word(s), false if it is clean\n"

"@see addBadWord()\n"
"@see filterString()\n"

"@tsexample\n"
"// In this game, \"Foobar\" is banned\n"
"%badWord = \"Foobar\";\n\n"
"// Add a banned word to the bad word filter\n"
"addBadWord(%badWord);\n\n"
"// Create the base string, can come from anywhere like user chat\n"
"%userText = \"Foobar\";\n\n"
"// Create a string of random letters\n"
"%replacementChars = \"knqwrtlzs\";\n\n"
"// If the text contains a bad word, filter it before printing\n"
"// Otherwise print the original text\n"
"if(containsBadWords(%userText))\n"
"{\n"
" // Filter the string\n"
" %filteredText = filterString(%userText, %replacementChars);\n\n"
" // Print filtered text\n"
" echo(%filteredText);\n"
"}\n"
"else\n"
" echo(%userText);\n\n"
"@endtsexample\n"

"@ingroup Game")
{
return gBadWordFilter->containsBadWords(text);
}
Expand Down
18 changes: 14 additions & 4 deletions Engine/source/app/badWordFilter.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,8 @@ class BadWordFilter
friend struct FilterTable;
Vector<FilterTable*> filterTables;

enum {
enum
{
TerminateNotFound = 0xFFFE,
TerminateFound = 0xFFFF,
MaxBadwordLength = 32,
Expand All @@ -52,12 +53,21 @@ class BadWordFilter
public:
bool addBadWord(const char *word);
bool setDefaultReplaceStr(const char *str);
const char* getDefaultReplaceStr(){ return defaultReplaceStr; }
const char* getDefaultReplaceStr()
{
return defaultReplaceStr;
}
void filterString(char *string, const char *replaceStr = NULL);
bool containsBadWords(const char *string);

static bool isEnabled() { return filteringEnabled; }
static void setEnabled(bool enable) { filteringEnabled = enable; }
static bool isEnabled()
{
return filteringEnabled;
}
static void setEnabled(bool enable)
{
filteringEnabled = enable;
}
static void create();
static void destroy();
};
Expand Down
Loading