Improved pattern language cheat sheet, added math evaluator cheat sheet
This commit is contained in:
WerWolv
parent
4878f70e58
commit
00072d0216
@ -27,9 +27,11 @@ namespace hex {
|
||||
private:
|
||||
bool m_aboutWindowOpen = false;
|
||||
bool m_patternHelpWindowOpen = false;
|
||||
bool m_mathHelpWindowOpen = false;
|
||||
|
||||
void drawAboutPopup();
|
||||
void drawPatternHelpPopup();
|
||||
void drawMathEvaluatorHelp();
|
||||
};
|
||||
|
||||
}
|
||||
@ -10,6 +10,24 @@ namespace hex {
|
||||
|
||||
}
|
||||
|
||||
|
||||
static void drawTitle(const std::string &title) {
|
||||
ImGui::TextColored(ImVec4(0.6F, 0.6F, 1.0F, 1.0F), title.c_str());
|
||||
}
|
||||
|
||||
static void drawCodeSegment(const std::string &id, const std::string &code) {
|
||||
ImGui::PushStyleColor(ImGuiCol_ChildBg, ImVec4(0.2F, 0.2F, 0.2F, 0.3F));
|
||||
ImGui::BeginChild(id.c_str(), ImVec2(-1, ImGui::CalcTextSize(code.c_str()).y));
|
||||
|
||||
ImGui::Text("%s", code.c_str());
|
||||
|
||||
ImGui::EndChild();
|
||||
ImGui::NewLine();
|
||||
ImGui::PopStyleColor();
|
||||
};
|
||||
|
||||
|
||||
|
||||
void ViewHelp::drawAboutPopup() {
|
||||
ImGui::SetNextWindowSizeConstraints(ImVec2(450, 300), ImVec2(450, 300));
|
||||
if (ImGui::BeginPopupModal("About", &this->m_aboutWindowOpen, ImGuiWindowFlags_NoResize)) {
|
||||
@ -33,10 +51,13 @@ namespace hex {
|
||||
ImGui::BulletText("ImGui-Addons by gallickgunner");
|
||||
ImGui::BulletText("ImGuiColorTextEdit by BalazsJako");
|
||||
ImGui::BulletText("capstone by aquynh");
|
||||
ImGui::BulletText("JSON for Modern C++ by nlohmann");
|
||||
ImGui::NewLine();
|
||||
ImGui::BulletText("GNU libmagic");
|
||||
ImGui::BulletText("OpenSSL libcrypto");
|
||||
ImGui::BulletText("GLFW3");
|
||||
ImGui::BulletText("LLVM");
|
||||
ImGui::BulletText("Python 3");
|
||||
|
||||
ImGui::EndChild();
|
||||
ImGui::PopStyleColor();
|
||||
@ -46,52 +67,37 @@ namespace hex {
|
||||
|
||||
void ViewHelp::drawPatternHelpPopup() {
|
||||
ImGui::SetNextWindowSizeConstraints(ImVec2(450, 300), ImVec2(450, 300));
|
||||
|
||||
constexpr static auto DrawTitle = [](const std::string &title) {
|
||||
ImGui::TextColored(ImVec4(0.6F, 0.6F, 1.0F, 1.0F), title.c_str());
|
||||
};
|
||||
|
||||
constexpr static auto DrawCodeSegment = [](const std::string &id, size_t height, const std::string &code) {
|
||||
ImGui::PushStyleColor(ImGuiCol_ChildBg, ImVec4(0.2F, 0.2F, 0.2F, 0.3F));
|
||||
ImGui::NewLine();
|
||||
ImGui::BeginChild(id.c_str(), ImVec2(-1, height));
|
||||
|
||||
ImGui::Text("%s", code.c_str());
|
||||
|
||||
ImGui::EndChild();
|
||||
ImGui::NewLine();
|
||||
ImGui::PopStyleColor();
|
||||
};
|
||||
|
||||
|
||||
ImGui::SetNextWindowSizeConstraints(ImVec2(450, 300), ImVec2(2000, 1000));
|
||||
if (ImGui::BeginPopupModal("Cheat Sheet", &this->m_patternHelpWindowOpen)) {
|
||||
if (ImGui::BeginPopupModal("Pattern Language Cheat Sheet", &this->m_patternHelpWindowOpen)) {
|
||||
ImGui::Text("ImHex Pattern Language Cheat Sheet");
|
||||
ImGui::Separator();
|
||||
ImGui::NewLine();
|
||||
|
||||
DrawTitle("Preprocessor directives");
|
||||
drawTitle("Preprocessor directives");
|
||||
ImGui::TextWrapped(
|
||||
"Preprocessor directives can be used to alter the code before it's being parsed. Supported are "
|
||||
"#define to replace one string with another and #include to include a separate file");
|
||||
DrawCodeSegment("preprocessor", 40,
|
||||
drawCodeSegment("preprocessor",
|
||||
"#define HEADER_OFFSET 0x100\n"
|
||||
"#include <cstdint.hexpat>\n"
|
||||
"#include \"mypattern.hexpat\""
|
||||
);
|
||||
|
||||
DrawTitle("Pragma directives");
|
||||
drawTitle("Pragma directives");
|
||||
ImGui::TextWrapped(
|
||||
"Pragma directives are used to give ImHex additional information about the code being read. Currently "
|
||||
"the following directives are supported.");
|
||||
DrawCodeSegment("pragma", 30,
|
||||
"// Allow this file to be loaded as pattern when a file identified as application/x-executable gets loaded"
|
||||
drawCodeSegment("pragma",
|
||||
"// Allow this file to be loaded as pattern when a file\n"
|
||||
"// identified as application/x-executable gets loaded\n"
|
||||
"#pragma MIME application/x-executable\n"
|
||||
);
|
||||
|
||||
DrawTitle("Built-in types");
|
||||
drawTitle("Built-in types");
|
||||
ImGui::TextWrapped(
|
||||
"The following built-in types are available for use");
|
||||
DrawCodeSegment("built-in", 80,
|
||||
drawCodeSegment("built-in",
|
||||
"u8, s8\n"
|
||||
"u16, s16\n"
|
||||
"u32, s32\n"
|
||||
@ -100,22 +106,22 @@ namespace hex {
|
||||
"float, double"
|
||||
);
|
||||
|
||||
DrawTitle("Variables and Arrays");
|
||||
drawTitle("Variables and Arrays");
|
||||
ImGui::TextWrapped(
|
||||
"Normal variables as well as arrays are used to highlight and display values. "
|
||||
"It is possible to create arrays within structs and unions that use the value of a previously "
|
||||
"declared variable as size.");
|
||||
DrawCodeSegment("vars arrays", 45,
|
||||
drawCodeSegment("vars arrays",
|
||||
"u32 variable;\n"
|
||||
"s8 string[16];\n"
|
||||
"u8 customSizedArray[variable];"
|
||||
);
|
||||
|
||||
DrawTitle("Structs");
|
||||
drawTitle("Structs");
|
||||
ImGui::TextWrapped(
|
||||
"To bundle multiple variables together, a struct can be used. To insert padding bytes which won't show "
|
||||
"up in the pattern data view or be highlighted, use the padding[size] syntax.");
|
||||
DrawCodeSegment("struct", 85,
|
||||
drawCodeSegment("struct",
|
||||
"struct Header {\n"
|
||||
" u32 magic;\n"
|
||||
" u8 version;\n"
|
||||
@ -124,31 +130,31 @@ namespace hex {
|
||||
"};"
|
||||
);
|
||||
|
||||
DrawTitle("Unions");
|
||||
drawTitle("Unions");
|
||||
ImGui::TextWrapped(
|
||||
"A union is used to make two or more variables occupy the same region of memory. "
|
||||
"The union will have the size of the biggest contained variable.");
|
||||
DrawCodeSegment("union", 55,
|
||||
drawCodeSegment("union",
|
||||
"union Color {\n"
|
||||
" u32 rgba;\n"
|
||||
" Components components;\n"
|
||||
"};"
|
||||
);
|
||||
|
||||
DrawTitle("Pointers");
|
||||
drawTitle("Pointers");
|
||||
ImGui::TextWrapped(
|
||||
"\"Another possible type of member in structs and unions are pointers. They are variables"
|
||||
"whose value is used as an offset from the start of the file to locate the actual offset. "
|
||||
"The leading type is treated as the data being pointed to and the trailing type as the size of the pointer.");
|
||||
DrawCodeSegment("pointer", 55,
|
||||
drawCodeSegment("pointer",
|
||||
"Data *data : u16;"
|
||||
);
|
||||
|
||||
DrawTitle("Bitfields");
|
||||
drawTitle("Bitfields");
|
||||
ImGui::TextWrapped(
|
||||
"To decode values that are stored in fields that don't follow the typical 8 bit alignment, bitfields can be used. "
|
||||
"The size of these fields get specified in numbers of bits.");
|
||||
DrawCodeSegment("bitfield", 70,
|
||||
drawCodeSegment("bitfield",
|
||||
"bitfield Permission {\n"
|
||||
" r : 1;\n"
|
||||
" w : 1;\n"
|
||||
@ -156,45 +162,120 @@ namespace hex {
|
||||
"};"
|
||||
);
|
||||
|
||||
DrawTitle("Enum");
|
||||
drawTitle("Enum");
|
||||
ImGui::TextWrapped(
|
||||
"If a value can only be a few specific values with special meaning, an enum can be used. "
|
||||
"The underlying type has to be specified using a unsigned, built-in type after the name. "
|
||||
"Entries can be listed with or without a value. The values start counting at zero and increase by one "
|
||||
"for every next entry");
|
||||
DrawCodeSegment("enum", 70,
|
||||
drawCodeSegment("enum",
|
||||
"enum OperatingSystem : u8 {\n"
|
||||
" Windows = 0x10,\n"
|
||||
" MacOSX,\n"
|
||||
" Linux\n"
|
||||
" Linux = 'L'\n"
|
||||
"};"
|
||||
);
|
||||
|
||||
DrawTitle("Using declarations");
|
||||
drawTitle("Using declarations");
|
||||
ImGui::TextWrapped(
|
||||
"A using declaration can be used to create type aliases for already existing types. This can be "
|
||||
"a built-in type, a struct, enum or another alias type.");
|
||||
DrawCodeSegment("using", 15,
|
||||
drawCodeSegment("using",
|
||||
"using magic_t = u32;"
|
||||
);
|
||||
|
||||
DrawTitle("Comments");
|
||||
drawTitle("Comments");
|
||||
ImGui::TextWrapped(
|
||||
"To create a comment the C // or /* */ syntax can be used. //-style comments end at the next new line "
|
||||
"and /*-style comments only end when at the next */.");
|
||||
DrawCodeSegment("comment", 55,
|
||||
drawCodeSegment("comment",
|
||||
"// This is a single line comment\n\n"
|
||||
"/* This is a\n"
|
||||
"multiline comment */"
|
||||
);
|
||||
|
||||
DrawTitle("Variable placement");
|
||||
drawTitle("Variable placement");
|
||||
ImGui::TextWrapped(
|
||||
"In order to highlight bytes and displaying their value in the pattern data window, "
|
||||
"a variable needs to be created and placed in memory. The following line of code creates"
|
||||
"a unsigned 32 bit variable named data and places it at offset 0x100."
|
||||
);
|
||||
DrawCodeSegment("var placement", 15, "u32 data @ 0x100;");
|
||||
drawCodeSegment("var placement", "u32 data @ 0x100;");
|
||||
ImGui::EndPopup();
|
||||
}
|
||||
}
|
||||
|
||||
void ViewHelp::drawMathEvaluatorHelp() {
|
||||
ImGui::SetNextWindowSizeConstraints(ImVec2(450, 300), ImVec2(450, 300));
|
||||
|
||||
ImGui::SetNextWindowSizeConstraints(ImVec2(450, 300), ImVec2(2000, 1000));
|
||||
if (ImGui::BeginPopupModal("Calculator Cheat Sheet", &this->m_mathHelpWindowOpen)) {
|
||||
ImGui::Text("ImHex Math Evaluator Cheat Sheet");
|
||||
ImGui::Separator();
|
||||
ImGui::NewLine();
|
||||
|
||||
ImGui::TextWrapped("ImGui has a simple math evaluator / calculator built-in. It works by parsing the "
|
||||
"expressions passed to it and displaying the result in the History table.");
|
||||
ImGui::NewLine();
|
||||
|
||||
drawTitle("Basic Operators");
|
||||
ImGui::TextWrapped(
|
||||
"The following basic mathematical operators are supported");
|
||||
drawCodeSegment("basicOperators",
|
||||
"+ : Addition\n"
|
||||
"- : Subtraction\n"
|
||||
"* : Multiplication\n"
|
||||
"/ : Division\n"
|
||||
"% : Modulus\n"
|
||||
"** : Exponentiation\n"
|
||||
"() : Brackets\n"
|
||||
"x = : Variable assignment");
|
||||
|
||||
drawTitle("Bitwise Operators");
|
||||
ImGui::TextWrapped(
|
||||
"The following bitwise operators are supported");
|
||||
drawCodeSegment("bitwiseOperators",
|
||||
"& : Bitwise AND\n"
|
||||
"| : Bitwise OR\n"
|
||||
"^ : Bitwise XOR\n"
|
||||
"~ : Bitwise NOT\n"
|
||||
"<< : Logical shift left\n"
|
||||
">> : Logical shift right\n"
|
||||
"## : Bitwise concatenation");
|
||||
|
||||
drawTitle("Boolean Operators");
|
||||
ImGui::TextWrapped(
|
||||
"The following bitwise operators are supported");
|
||||
drawCodeSegment("booleanOperators",
|
||||
"&& : Boolean AND\n"
|
||||
"|| : Boolean OR\n"
|
||||
"^^ : Boolean XOR\n"
|
||||
"! : Boolean NOT\n"
|
||||
"== : Equality comparison\n"
|
||||
"!= : Inequality comparison\n"
|
||||
"> : Greater than comparison\n"
|
||||
"< : Less than comparison\n"
|
||||
">= : Greater than or equals comparison\n"
|
||||
"<= : Less than or equals comparison");
|
||||
|
||||
drawTitle("Built-in Functions");
|
||||
ImGui::TextWrapped(
|
||||
"The following functions are built into the evaluator");
|
||||
drawCodeSegment("functions",
|
||||
"sin(x) : Sine function\n"
|
||||
"cos(x) : Cosine function\n"
|
||||
"tan(x) : Tangent function\n"
|
||||
"ceil(x) : Rounds value to next bigger integer\n"
|
||||
"floor(x) : Rounds value to next smaller integer\n"
|
||||
"sign(x) : Returns the value's sign\n"
|
||||
"abs(x) : Absolute value\n"
|
||||
"ln(x) : Natural Logarithm\n"
|
||||
"lb(x) : Logarithm with base 2\n"
|
||||
"log(x, b) : Logarithm with custom base. Defaults to base 10\n"
|
||||
"clear() : Clear History and variables\n"
|
||||
"read(a) : Read 1 byte from loaded data\n"
|
||||
"write(a, x) : Write 1 byte to loaded data");
|
||||
|
||||
ImGui::EndPopup();
|
||||
}
|
||||
}
|
||||
@ -202,21 +283,24 @@ namespace hex {
|
||||
void ViewHelp::createView() {
|
||||
this->drawAboutPopup();
|
||||
this->drawPatternHelpPopup();
|
||||
this->drawMathEvaluatorHelp();
|
||||
}
|
||||
|
||||
void ViewHelp::createMenu() {
|
||||
if (ImGui::BeginMenu("Help")) {
|
||||
if (ImGui::MenuItem("About", ""))
|
||||
View::doLater([this]{
|
||||
ImGui::OpenPopup("About");
|
||||
this->m_aboutWindowOpen = true;
|
||||
});
|
||||
if (ImGui::MenuItem("About", "")) {
|
||||
View::doLater([] { ImGui::OpenPopup("About"); });
|
||||
this->m_aboutWindowOpen = true;
|
||||
}
|
||||
ImGui::Separator();
|
||||
if (ImGui::MenuItem("Cheat Sheet", ""))
|
||||
View::doLater([this]{
|
||||
ImGui::OpenPopup("Cheat Sheet");
|
||||
this->m_patternHelpWindowOpen = true;
|
||||
});
|
||||
if (ImGui::MenuItem("Pattern Language Cheat Sheet", "")) {
|
||||
View::doLater([] { ImGui::OpenPopup("Pattern Language Cheat Sheet"); });
|
||||
this->m_patternHelpWindowOpen = true;
|
||||
}
|
||||
if (ImGui::MenuItem("Calculator Cheat Sheet", "")) {
|
||||
View::doLater([] { ImGui::OpenPopup("Calculator Cheat Sheet"); });
|
||||
this->m_mathHelpWindowOpen = true;
|
||||
}
|
||||
ImGui::EndMenu();
|
||||
}
|
||||
}
|
||||
|
||||
Loading…
Reference in New Issue
Block a user