aboutsummaryrefslogtreecommitdiff
path: root/vendor/zgui/libs/imgui_test_engine/thirdparty/Str/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/zgui/libs/imgui_test_engine/thirdparty/Str/README.md')
-rw-r--r--vendor/zgui/libs/imgui_test_engine/thirdparty/Str/README.md71
1 files changed, 0 insertions, 71 deletions
diff --git a/vendor/zgui/libs/imgui_test_engine/thirdparty/Str/README.md b/vendor/zgui/libs/imgui_test_engine/thirdparty/Str/README.md
deleted file mode 100644
index 3573ea9..0000000
--- a/vendor/zgui/libs/imgui_test_engine/thirdparty/Str/README.md
+++ /dev/null
@@ -1,71 +0,0 @@
-```
-Str
-Simple C++ string type with an optional local buffer, by Omar Cornut
-https://github.com/ocornut/str
-
-LICENSE
-This software is in the public domain. Where that dedication is not
-recognized, you are granted a perpetual, irrevocable license to copy,
-distribute, and modify this file as you see fit.
-
-USAGE
-Include Str.h in whatever places need to refer to it.
-In ONE .cpp file, write '#define STR_IMPLEMENTATION' before the #include.
-This expands out the actual implementation into that C/C++ file.
-
-NOTES
-- This isn't a fully featured string class.
-- It is a simple, bearable replacement to std::string that isn't heap abusive nor bloated (can actually be debugged by humans!).
-- String are mutable. We don't maintain size so length() is not-constant time.
-- Maximum string size currently limited to 2 MB (we allocate 21 bits to hold capacity).
-- Local buffer size is currently limited to 1023 bytes (we allocate 10 bits to hold local buffer size).
-- We could easily raise those limits if we are ok to increase the structure overhead in 32-bits mode.
-- In "non-owned" mode for literals/reference we don't do any tracking/counting of references.
-- Overhead is 8-bytes in 32-bits, 16-bytes in 64-bits (12 + alignment).
-- I'm using this code but it hasn't been tested thoroughly.
-
-The idea is that you can provide an arbitrary sized local buffer if you expect string to fit
-most of the time, and then you avoid using costly heap.
-
-No local buffer, always use heap, sizeof()==8~16 (depends if your pointers are 32-bits or 64-bits)
-
- Str s = "hey"; // use heap
-
-With a local buffer of 16 bytes, sizeof() == 8~16 + 16 bytes.
-
- Str16 s = "filename.h"; // copy into local buffer
- Str16 s = "long_filename_not_very_long_but_longer_than_expected.h"; // use heap
-
-With a local buffer of 256 bytes, sizeof() == 8~16 + 256 bytes.
-
- Str256 s = "long_filename_not_very_long_but_longer_than_expected.h"; // copy into local buffer
-
-Common sizes are defined at the bottom of Str.h, you may define your own.
-
-Functions:
-
- Str256 s;
- s.set("hello sailor"); // set (copy)
- s.setf("%s/%s.tmp", folder, filename); // set (w/format)
- s.append("hello"); // append. cost a length() calculation!
- s.appendf("hello %d", 42); // append (w/format). cost a length() calculation!
- s.set_ref("Hey!"); // set (literal/reference, just copy pointer, no tracking)
-
-Constructor helper for format string: add a trailing 'f' to the type. Underlying type is the same.
-
- Str256f filename("%s/%s.tmp", folder, filename); // construct (w/format)
- fopen(Str256f("%s/%s.tmp, folder, filename).c_str(), "rb"); // construct (w/format), use as function param, destruct
-
-Constructor helper for reference/literal:
-
- StrRef ref("literal"); // copy pointer, no allocation, no string copy
- StrRef ref2(GetDebugName()); // copy pointer. no tracking of anything whatsoever, know what you are doing!
-
-All StrXXX types derives from Str and instance hold the local buffer capacity.
-So you can pass e.g. Str256* to a function taking base type Str* and it will be functional!
-
- void MyFunc(Str& s) { s = "Hello"; } // will use local buffer if available in Str instance
-
-(Using a template e.g. Str<N> we could remove the LocalBufSize storage but it would make passing typed Str<> to functions tricky.
- Instead we don't use template so you can pass them around as the base type Str*. Also, templates are ugly.)
-```