YourWishes/Dawn
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Documented most of the still relevant tools

Browse Source
This commit is contained in:
Dominic Masters
2023-03-01 10:12:20 -08:00
parent b9625e7f14
commit 8cc122d97c
11 changed files with 225 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
src/dawntools/util/CMakeLists.txt
View File

@ -10,6 +10,7 @@ set(
${D}/DawnTool.cpp
${D}/File.cpp
${D}/Language.cpp
${D}/CodeGen.cpp
CACHE INTERNAL
${DAWN_CACHE_TARGET}

75
src/dawntools/util/CodeGen.cpp Normal file
View File

@ -0,0 +1,75 @@
// Copyright (c) 2023 Dominic Masters
//
// This software is released under the MIT License.
// https://opensource.org/licenses/MIT
#include "CodeGen.hpp"
using namespace Dawn;
void CodeGen::line(
std::vector<std::string> *out,
std::string contents,
std::string tabs
) {
out->push_back(tabs + contents);
}
void CodeGen::lines(
std::vector<std::string> *out,
std::vector<std::string> lines,
std::string tabs
) {
auto itLine = lines.begin();
while(itLine != lines.end()) {
line(out, *itLine, tabs);
++itLine;
}
}
void CodeGen::classGen(
std::vector<std::string> *out,
struct ClassGenInfo info
) {
std::vector<std::string> buffer;
line(out, "#pragma once", "");
line(out, "", "");
if(info.includes.size() > 0) {
lines(out, info.includes, "");
line(out, "", "");
}
line(out, "namespace Dawn {", "");
line(out, "class " + info.clazz + (info.extend.size() == 0 ? "{" : " : public " + info.extend + " {" ), " ");
if(info.protectedCode.size() > 0) {
line(out, "protected:", " ");
lines(out, info.protectedProperties, " ");
line(out, "", " ");
lines(out, info.protectedCode, " ");
}
if(info.publicCode.size() > 0 || info.constructorArgs.size() > 0 || info.constructorCode.size() > 0) {
line(out, "public:", " ");
lines(out, info.publicProperties, " ");
line(out, "", " ");
line(out, info.clazz + "(" + info.constructorArgs + ")" + (info.extend.size() > 0 ? " : " + info.extend + "(" + info.extendArgs + ")" : "") + " {", " ");
lines(out, info.constructorCode, " ");
line(out, "}", " ");
if(info.publicCode.size() > 0) {
line(out, "", " ");
lines(out, info.publicCode, " ");
}
}
line(out, "};", " ");
line(out, "}", "");
}
void CodeGen::methodGen(
std::vector<std::string> *out,
struct MethodGenInfo info
) {
line(out, info.type + " " + info.name + "(" + info.args + ") " + ( info.isOverride ? "override" : "" ) + "{", "");
lines(out, info.body, " ");
line(out, "}", "");
}

80
src/dawntools/util/CodeGen.hpp
View File

@ -34,70 +34,52 @@ namespace Dawn {
class CodeGen {
protected:
/**
* Append a line of code to the output buffer.
*
* @param out Output buffer to append to.
* @param contents Line of code to append to the buffer.
* @param tabs Prepended string of spaces/tabs.
*/
static void line(
std::vector<std::string> *out,
std::string contents,
std::string tabs
) {
out->push_back(tabs + contents);
}
);
/**
* Append an array of lines to the output buffer.
*
* @param out Output buffer to append to.
* @param lines List of lines of code to append to the buffer.
* @param tabs Prepended string of tabs/spaces to prepend to EACH line.
*/
static void lines(
std::vector<std::string> *out,
std::vector<std::string> lines,
std::string tabs
) {
auto itLine = lines.begin();
while(itLine != lines.end()) {
line(out, *itLine, tabs);
++itLine;
}
}
);
/**
* Generate code of a class
*
* @param out Output buffer to write the class to.
* @param info Information about how the class should be generated.
*/
static void classGen(
std::vector<std::string> *out,
struct ClassGenInfo info
) {
std::vector<std::string> buffer;
line(out, "#pragma once", "");
line(out, "", "");
if(info.includes.size() > 0) {
lines(out, info.includes, "");
line(out, "", "");
}
line(out, "namespace Dawn {", "");
line(out, "class " + info.clazz + (info.extend.size() == 0 ? "{" : " : public " + info.extend + " {" ), " ");
if(info.protectedCode.size() > 0) {
line(out, "protected:", " ");
lines(out, info.protectedProperties, " ");
line(out, "", " ");
lines(out, info.protectedCode, " ");
}
if(info.publicCode.size() > 0 || info.constructorArgs.size() > 0 || info.constructorCode.size() > 0) {
line(out, "public:", " ");
lines(out, info.publicProperties, " ");
line(out, "", " ");
line(out, info.clazz + "(" + info.constructorArgs + ")" + (info.extend.size() > 0 ? " : " + info.extend + "(" + info.extendArgs + ")" : "") + " {", " ");
lines(out, info.constructorCode, " ");
line(out, "}", " ");
if(info.publicCode.size() > 0) {
line(out, "", " ");
lines(out, info.publicCode, " ");
}
}
line(out, "};", " ");
line(out, "}", "");
}
);
/**
* Generate code of a method/function.
*
* @param out Output buffer to write the method to.
* @param info Information about how the method should be generated.
*/
static void methodGen(
std::vector<std::string> *out,
struct MethodGenInfo info
) {
line(out, info.type + " " + info.name + "(" + info.args + ") " + ( info.isOverride ? "override" : "" ) + "{", "");
lines(out, info.body, " ");
line(out, "}", "");
}
);
};
}

26
src/dawntools/util/DawnTool.hpp
View File

@ -20,11 +20,37 @@ namespace Dawn {
std::vector<std::string> args;
std::map<std::string, std::string> flags;
/**
* Get the required flags for this tool. These flags will be checked in
* the passed args to the CLI.
*
* @return Array of required flags.
*/
virtual std::vector<std::string> getRequiredFlags();
/**
* Get the optional flags for this tool. Mapped by key value pair where
* the value is some default value you want for your tool.
*
* @return Array of optional flags.
*/
virtual std::map<std::string, std::string> getOptionalFlags();
public:
/**
* Execute the Dawn Tool from the CLI, functionally identically to main()
*
* @param argc Count of arguments in the array.
* @param argv Array of arguments.
* @return int32_t
*/
int32_t exec(const int32_t argc, const char *argv[]);
/**
* Overridable start method after the tool has been set up.
*
* @return 0 for success, otherwise for failure.
*/
virtual int32_t start() = 0;
};
}

8
src/dawntools/util/File.hpp
View File

@ -125,8 +125,16 @@ namespace Dawn {
*/
bool_t writeRaw(char *data, size_t );
/**
* Set the position of the cursor of the file reader.
*
* @param pos Position to set.
*/
void setPosition(size_t pos);
/**
* Destruct the File manager.
*/
~File();
};
}

7
src/dawntools/util/Language.hpp
View File

@ -13,6 +13,13 @@ struct LanguageString {
std::string text;
};
/**
* Shorthand method to save a list of languages to a file.
*
* @param languagesDir Directory where the language(s) are to be stored.
* @param strings List of strings to store.
* @return 0 for success, otherwise for failure.
*/
static int32_t languageSaveStrings(
std::string languagesDir,
std::vector<struct LanguageString> strings

41
src/dawntools/util/XmlParser.hpp
View File

@ -10,8 +10,29 @@ namespace Dawn {
template<typename T>
class XmlParser {
protected:
/**
* Get the required attributes for this Xml Node to have.
*
* @return Vector of strings of required attribute keys.
*/
virtual std::vector<std::string> getRequiredAttributes() = 0;
/**
* Return optional attributes with defaults for this node to have.
*
* @return Key-Value Pair of optional attributes and defaults.
*/
virtual std::map<std::string, std::string> getOptionalAttributes() = 0;
/**
* Callback to be invoked upon successful parse of this node.
*
* @param node Node that was parsed.
* @param values KVP of values from the required and optional attrs.
* @param output Templated output of the parse from this method.
* @param error Pointer to a string to write-out any errors.
* @return Non 0 for error, 0 for success.
*/
virtual int32_t onParse(
Xml *node,
std::map<std::string, std::string> values,
@ -20,18 +41,38 @@ namespace Dawn {
) = 0;
public:
/**
* Common parse method to parse a duration from a value string.
*
* @param duration Duration string to parse.
* @return The parsed duration.
*/
static std::string parseDuration(std::string duration) {
std::string dur = duration;
if(dur.find('.') == std::string::npos) dur += ".0";
return dur + "f";
}
/**
* Common parse method to parse an easing from a value string.
*
* @param e Easing string to parse.
* @return The parsed ease.
*/
static std::string parseEase(std::string e) {
if(e == "out-quad") return "&easeOutQuad";
if(e == "linear") return "&easeLinear";
return "";
}
/**
* Handles parsing of an Xml node.
*
* @param xml Xml node to parse.
* @param output Output struct to put the output data.
* @param error Pointer to the string for errors to be stored.
* @return 0 for success, otherwise for error.
*/
int32_t parse(Xml *xml, T *output, std::string *error) {
std::map<std::string, std::string> values;

1
src/dawntools/util/file.hpp
View File

@ -59,7 +59,6 @@ int32_t readAhead(
char *needles, int32_t needleCount
);
/**
* Skips any characters found in the needles.
*

17
src/dawntools/util/image.hpp
View File

@ -13,6 +13,23 @@
#include <stb_image_resize.h>
#include <stb_image_write.h>
/**
* Unused currently.
*
* @param source
* @param sourceWidth
* @param sourceHeight
* @param dest
* @param destWidth
* @param destHeight
* @param cropX
* @param cropY
* @param cropWidth
* @param cropHeight
* @param pasteX
* @param pasteY
* @param channels
*/
void imageCopy(
uint8_t *source, int32_t sourceWidth, int32_t sourceHeight,
uint8_t *dest, int32_t destWidth, int32_t destHeight,

6
src/dawntools/util/string.hpp
View File

@ -8,6 +8,12 @@
#pragma once
#include "dawnsharedlibs.hpp"
/**
* Remove all instances of a character from a C-Styled string.
*
* @param string String to remove characters from.
* @param remove Character to remove.
*/
static inline void stringRemoveAll(char *string, char remove) {
size_t len = strlen(string);
size_t i, j;

13
src/dawntools/util/xml.hpp
View File

@ -63,6 +63,19 @@ void xmlLoad(xml_t *xml, char *data);
*/
void xmlDispose(xml_t *xml);
/**
* Find an attribute index by its name.
*
* @param xml Xml node to get the attribute from.
* @param name The name of the attribute you're trying to find.
* @return -1 if not found, otherwise the index of the attribute within array.
*/
int16_t xmlGetAttributeByName(xml_t *xml, char *name);
/**
* Checks if a given character is a whitespace character or not.
*
* @param c Character to check if a whitespace.
* @return True if whitespace, otherwise false.
*/
bool xmlIsWhitespace(char c);