Allows to use string literals loaded from a separate text file through a dictionary of key/message pairs. More...

Classes
struct	Message
	A message string with a unique Key. More...

Macros
#define	MESSAGES_MAX_KEY_LENGTH 30
	Maximum length of a single key.

#define	MESSAGES_MAX_MSG_LENGTH 120
	Maximum length of a single message text.

#define	MESSAGES_COUNT 32
	Current amount of lines contained within the loc.txt file.

#define	MESSAGES_FILENAME "loc.txt"
	Defines the localization's filename.

#define	MESSAGES_NOKEYFOUND "NO MESSAGE FOUND FOR THIS KEY"
	String literal returned when no message with a matching key was found.

#define	MSG_SHOW(dict, key) printf(msgGet(dict,key))
	Quick macro for showing a message.

#define	MSG_SHOWN(dict, key) printf(msgGet(dict,key)); printf("\n")
	Quick macro for showing a message. Prints a newline character at the end.

#define	MSG_SHOWS(dict, key) printf(msgGet(dict,key)); printf(" ")
	Quick macro for showing a message. Prints a single whitespace character at the end.

#define	MSG_SHOWV(dict, key, ...) printf(msgGet(dict,key),__VA_ARGS__)
	Quick macro for showing a message. Accepts variadic arguments.

#define	MSG_SHOWVN(dict, key, ...) printf(msgGet(dict,key),__VA_ARGS__); printf("\n")
	Quick macro for showing a message. Accepts variadic arguments and prints a newline character at the end.

#define	MSG_SHOWVS(dict, key, ...) printf(msgGet(dict,key),__VA_ARGS__); printf(" ")
	Quick macro for showing a message. Accepts variadic arguments and prints a single whitespace character at the end.

Functions
void	msgInitFromFile (const char *)
	Populates the global singleton GLOBAL_MSGS with contents of the provided file.

char *	msgGet (const Message[], const char *)
	Retrieves a message with the matching key value.

Variables
Message	GLOBAL_MSGS [MESSAGES_COUNT]
	A global singleton that holds all the message strings.

Detailed Description

Allows to use string literals loaded from a separate text file through a dictionary of key/message pairs.

The localization text inside the file should follow this format:

Keys should be unique. If there are duplicates, the pair closer to the file's top will always be returned.
Keys should not include any whitespaces - inside them, or before them.
While the format of the key itself isn't important, it is preferrable to write them in CAPITALIZED_SNAKE_CASE to make them stand out from messages.
After the key, one whitespace is mandatory to indicate that the rest of the line is a message.
Any whitespaces after the mandatory one WILL be preserved.
A message will consist of all characters between the mandatory single whitespace and a newline character.
Make sure that each key and message are no longer than what is specified in this header under MESSAGES_MAX_KEY_LENGTH and MESSAGES_MAX_MSG_LENGTH. Those lengths do not include the null terminator.
Messages can contain string formatters, such as s, c, d etc.
Special characters that use backward slashes such as "\n","\t","\0" will be read a literal characters and won't work.

Here's a few valid examples: TEST Hello world! TESTPARAM This is a digit d TESTPARAM2 This is a really long digit %10d PRESERVE_THREESPACES I will have 3 spaces when I'm printed! IWILLBREAK STUFF A struct resulting from reading this line will be: Key = IWILLBREAK, Message=STUFF A Struct resulting...

Warning: When you add more lines, make sure to update MESSAGES_COUNT accordingly!

Macro Definition Documentation

◆ MESSAGES_MAX_KEY_LENGTH

#define MESSAGES_MAX_KEY_LENGTH 30

Maximum length of a single key.

Warning: If you change this value, make sure that the regular expression inside msgInitFromFile matches the new value!

◆ MESSAGES_MAX_MSG_LENGTH

#define MESSAGES_MAX_MSG_LENGTH 120

Maximum length of a single message text.

Warning: If you change this value, make sure that the regular expression inside msgInitFromFile matches the new value!

Keep in mind this value only cares about the raw line inside the localization file. If a really lengthy line includes string formatting, like 'd', replacing it with a great integer might result in a string longer than the value of this macro.

Function Documentation

◆ msgGet()

char * msgGet	(	const Message	messages[],
		const char *	key )

Retrieves a message with the matching key value.

Parameters

messages	An array of Message structs to search through.
key	The key to look for.

Returns: Text of the message with the matching key. If no key was found, the message will be MESSAGE_NOKEYFOUND_FORMAT.

Rules of strcmp() apply when it comes to key strings comparison.

◆ msgInitFromFile()

void msgInitFromFile ( const char * sourceFile )

Populates the global singleton GLOBAL_MSGS with contents of the provided file.

Parameters

sourceFile Path to the target localization file.

If no matching file was found, perror() is called and the singleton is not populated with anything.

Variable Documentation

◆ GLOBAL_MSGS

Message GLOBAL_MSGS[MESSAGES_COUNT]

extern

A global singleton that holds all the message strings.

Warning: Make sure to populate it with msgInitFromFile(const char*) beforehand!