"$$$" is a Ruby script that browses your source code before compilation and generates extra source code for you. It's main purpose is to extend C++ to include Ruby Symbols and Lazy Enum definition.
1. It borrows the idea of "Symbols" from Ruby, which is a class that is both an integer and a string. Symbols are very fast with maps (due to the integer component), but be usefull and readable when you want to serialise them (due to the string component). The symbol code is very small and only takes the same amount of bytes as an unsigned int.
2. Being pestered by Jacmoe, I've added "Lazy" enums. You can define enums in the middle of the code, which the Ruby parser will pre-create the Enum, and even classes to convert them into strings back and forth.
It doesn't alter your source code at all, it just writes two extra files for your compiler to use.
How do I use it? Is it complicated?
To introduce a Symbol or String into code, you need to prefix it with a dollar sign. "$", it should be on every keyboard and Visual Studio seems fine with it as syntax. Next you just need to follow the simple rules; Use CamelCase and if it has an underscore (_) then it's an enum.
Code: Select all
$name // Symbol
$wowThisIsAReallyLongNameForASymbolIsntIt // Symbol
$aaaaa // Symbol
$name // Symbol, already defined.
$Priority_Low // Enum named Priority, with a value Low.
$Priority_High // Same as above but HighFeatures
Symbols and Lazy Enums can be converted into strings and back if you so wish.
Code: Select all
std::string name = $Name.str(); => "Name"
std::cout << $Name << "\n"; => "Name"
Enums<Priority>::str($Priority_Low) => "Low"
Enums<Priority>::priority("Low") => $Priority_LowCode: Select all
#include "AutoGenerated.h"
#include "ExampleWorkQueue.h"
#include <string>
#include <map>
class Message
{
public:
Message(const std::string& to, const std::string& from, Priority = $Priority_Medium)
: mTo(to), mFrom(from), mPriority(priority)
{
}
void addData(const Symbol& field_name, const std::string& value)
{
data[field_name] = value;
}
void send()
{
if (mPriority == $Priority_Important)
gWorkQueue.push_front(*this);
else
gWorkQueue.push_back(*this);
}
protected:
std::string mTo, mFrom;
Priority mPriority;
std::map<Symbol, std::string> mData;
};
void main()
{
Message message1("betajaen", "jacmoe", $Priority_Low);
message1.addData($Content, "Begon fowl beastie!");
message1.send();
Message message2("betajaen", "sinbad", $Priority_Important);
message2.addData($Content, "Help! Message server is on fire!");
message2.addData($Attachment, base64(get_photo()));
message2.send();
}1. Ruby is required. So you can fetch that off the internet somewhere. Use the Windows installer if you can.
2. Download the attachment.
3. Copy "$$$.rb", "AutoGenerated.cpp", "AutoGenerated.h" to your source folder
4. Add both .cpp and .h files into your project file.
5. In Visual Studio (other compilers would be similar), Goto your project settings, BuildEvents, Pre-Build Event then add "ruby $$$.rb" to the CommandLine option.
6. Compile.
Each time you now do a compile, it'll browse the source and generate the enums and symbols for you.
Future plans?
- Ruby "Intern" function which will turn any string to a Symbol.
