Version 1.0.0 release

.github/workflows/cpack-multi-platform.yml

@@ -1,8 +1,6 @@
 name: CPack Multi-Platform
 
 on:
-  push:
-    branches: [ "dev" ]
   pull_request:
     branches: [ "main" ]
 

CHANGELOG.md

@@ -7,6 +7,137 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
+## [v1.0.0](https://github.com/dr8co/LiteString/compare/v0.1.0...v1.0.0) - 2024-05-01
+
+### Commits
+
+- Apply function attributes [`510c822`](https://github.com/dr8co/LiteString/commit/510c82208eb7ce833265dac1875707b47531decc)
+- Update the documentation [`14e378e`](https://github.com/dr8co/LiteString/commit/14e378e22e3bf1a8296ae6e7b144029c0c21734a)
+- Update the installation prefix in the pkgConfig file [`7040d43`](https://github.com/dr8co/LiteString/commit/7040d437118804458f42fa50cef4bc01426b91b1)
+- ci: Merge static and shared build [`36dff5e`](https://github.com/dr8co/LiteString/commit/36dff5eef59e230925136ebb55f04e114fd91ee9)
+- Build shared libraries only [`9f3af74`](https://github.com/dr8co/LiteString/commit/9f3af743b0a830a8ff8b4694fe13e954122ae9fc)
+- ci: Isolate Windows build [`3114404`](https://github.com/dr8co/LiteString/commit/3114404f46e29e9ba6f9382b1cb84189048e0492)
+- ci: Static build on Windows [`4decb7d`](https://github.com/dr8co/LiteString/commit/4decb7ded878147c2f7ed30670975d5ee08a3173)
+- build: Reconfigure optional builds [`f415fc8`](https://github.com/dr8co/LiteString/commit/f415fc84ae7eb9866dedfce16fc13cdaae0c1ff9)
+- ci: Disable shared build on Windows [`23dc4b9`](https://github.com/dr8co/LiteString/commit/23dc4b90c3d683f36d988294efa270bad76c9c30)
+- Configure MSVC Runtime Library [`3d61e75`](https://github.com/dr8co/LiteString/commit/3d61e75d77db1bf4f1af1509df6a8c9c017c9b6a)
+- Update changelog [`e7a3fbc`](https://github.com/dr8co/LiteString/commit/e7a3fbc26d1fb26ad21f2be03641d7ba8483d774)
+- ci: Build shared libraries on all platforms [`33cad8f`](https://github.com/dr8co/LiteString/commit/33cad8f8387de65369f2a5b7e362b4729d589eb0)
+- Update build instructions [`d70fd59`](https://github.com/dr8co/LiteString/commit/d70fd59b21f1506b995d20f0744e6fd48661e0a5)
+- Organize input files [`dec0c80`](https://github.com/dr8co/LiteString/commit/dec0c80eb37dc14565a1a5d6949848a21610e1bb)
+- ci: Test the cpack workflow [`2214cf5`](https://github.com/dr8co/LiteString/commit/2214cf5931ccfe648f79e169a68d8af71130b6c1)
+- Test Packaging [`1e1a7c5`](https://github.com/dr8co/LiteString/commit/1e1a7c5212b86df158a7b3d4ca46161533e4df53)
+- Disable unreleased versions [`c04225c`](https://github.com/dr8co/LiteString/commit/c04225cff5b20f2d4184ef6d3539398edd913b33)
+- ci: Disable shared build on Windows [`dc6340c`](https://github.com/dr8co/LiteString/commit/dc6340c57f793f7bd6bcf7421cdd4b178dfa8497)
+- Update the table of contents [`19ba0d3`](https://github.com/dr8co/LiteString/commit/19ba0d383f25001e7ef70fb41896abe79ebb7aa2)
+- Fix a typo in the pcfonfig template file [`c7625a1`](https://github.com/dr8co/LiteString/commit/c7625a1aca84ff429cd4b4e16413d57393923281)
+- ci: Build shared libraries only [`7017605`](https://github.com/dr8co/LiteString/commit/701760534cd1d8e179b58f34e2e0600da8bf369a)
+- Diagnostics [`e3acf0d`](https://github.com/dr8co/LiteString/commit/e3acf0db808b2da37132a4865624f81606370b29)
+- doc: fix typo in README.md [`d530060`](https://github.com/dr8co/LiteString/commit/d530060047cb40d4be2f2b21f3041e6d0b0c7301)
+- Disable shared build on Windows [`1b32881`](https://github.com/dr8co/LiteString/commit/1b32881fbe2624b05942a15cefe691adc4ba178b)
+
 ## v0.1.0 - 2024-04-29
 
-Initial Pre-Release.
+### Commits
+
+- Break down the tests [`198d410`](https://github.com/dr8co/LiteString/commit/198d410313bf348eb3a6bdf2d02d1fef0f3f5c57)
+- Regress back to a normal library [`7d806f5`](https://github.com/dr8co/LiteString/commit/7d806f554e3bc290716f06540480c7478c5c4316)
+- Make the library header-only [`162a0a8`](https://github.com/dr8co/LiteString/commit/162a0a8ae231ff9b94ab6c87a820af583f54e780)
+- Import initial code from https://github.com/dr8co/Cachetron [`0fa6f8b`](https://github.com/dr8co/LiteString/commit/0fa6f8b4e3501da0d309d05b6a95b5d9e8400c10)
+- Use Google Test Suite for testing [`56a2a9e`](https://github.com/dr8co/LiteString/commit/56a2a9efa34410a80aa790c871ec4550665d196d)
+- Add a README.md for examples [`1a5b15a`](https://github.com/dr8co/LiteString/commit/1a5b15af2d21ff5d6e93ea5007429c4c909505fe)
+- Initialize the project [`c513c43`](https://github.com/dr8co/LiteString/commit/c513c43000ca4aaebd56ce4e83bdc96da26d3be1)
+- Add conversion functions [`56ea64b`](https://github.com/dr8co/LiteString/commit/56ea64b01b4a3dfc4f89c4612ecb40f081577241)
+- Test the newly added methods [`3a24fa4`](https://github.com/dr8co/LiteString/commit/3a24fa4e5bca1b0b4220f577ff37856a560fb1cd)
+- Update the library documentation [`1e12748`](https://github.com/dr8co/LiteString/commit/1e127480ba21547b4ea85c52396fedb3d9e60be0)
+- Refactor tests [`e8739ab`](https://github.com/dr8co/LiteString/commit/e8739abf268d7bb27b0eff06231322142bd09cdd)
+- Add tests for untested functions [`75853de`](https://github.com/dr8co/LiteString/commit/75853de13a04263667ee385ac24f6922e6a9927d)
+- Match substrings using the Knuth-Morris-Pratt algorithm [`2506f5e`](https://github.com/dr8co/LiteString/commit/2506f5e1facfd46c6452fb2b300019c64b45c03b)
+- Mark functions with attributes [`7067b12`](https://github.com/dr8co/LiteString/commit/7067b1233c6dc9e3853ee910893607e472d74442)
+- Outline the contribution guidelines [`76c4592`](https://github.com/dr8co/LiteString/commit/76c45927896862792926458906aad37b5444c5e3)
+- Add new methods [`d3c73e4`](https://github.com/dr8co/LiteString/commit/d3c73e4931a664cef10c3ec55ec76c0967698e56)
+- Document the API [`5e87c54`](https://github.com/dr8co/LiteString/commit/5e87c5416c39abbc7d45d6ef9cda97987930fbc5)
+- Declare the functions inline [`0f6d106`](https://github.com/dr8co/LiteString/commit/0f6d106cc6c9cbc392aceab7344ee2f309e49665)
+- Update library information [`cf0d8f7`](https://github.com/dr8co/LiteString/commit/cf0d8f70e3f35163e30e3726edc2c4356e890bb5)
+- Rename the modifiers test suite [`d52d092`](https://github.com/dr8co/LiteString/commit/d52d0929e7413c493df9073945d121dd25a6b93b)
+- Add more specialized search functions [`104c87c`](https://github.com/dr8co/LiteString/commit/104c87c07fdddfdeaa758948720a55f5fa34af67)
+- Add the community code of conduct [`3adf6ce`](https://github.com/dr8co/LiteString/commit/3adf6ce502d1a1723e485bbbb907de518685ab26)
+- Rename the conversion test suite [`64c3c23`](https://github.com/dr8co/LiteString/commit/64c3c23c9c7cef6479138cd646bd3eb2304c1566)
+- Optimize search methods [`12c3d65`](https://github.com/dr8co/LiteString/commit/12c3d65a207f4f2ccada4949530f11f1750654fe)
+- Bugfix: Fix attribute availability detection [`32f28e8`](https://github.com/dr8co/LiteString/commit/32f28e83c1d01e4a68fa88e40b373049e26d8dee)
+- Configure project packaging [`034d507`](https://github.com/dr8co/LiteString/commit/034d5076ba5a79c40fd307b72ea332a5cf770430)
+- Update function signatures [`95eb806`](https://github.com/dr8co/LiteString/commit/95eb80697d8d866858ee651e31da3fd62df3d5ae)
+- Add package generation CI [`0bead51`](https://github.com/dr8co/LiteString/commit/0bead5142b1ac8ef21d71fbfbe69f36a8499ff82)
+- Reconfigure CPack settings [`ca068e0`](https://github.com/dr8co/LiteString/commit/ca068e0a9132b2f85094f0ab0fd6c8ed4deadb72)
+- Rename functions appropriately [`da8c344`](https://github.com/dr8co/LiteString/commit/da8c3444968ccb4cb7e84e2d49d28263ebb65c12)
+- Add a C++ example: simple grep [`4accd1a`](https://github.com/dr8co/LiteString/commit/4accd1ababcdc489d38bf54f0139fafdbb715532)
+- Add a C example [`f31e937`](https://github.com/dr8co/LiteString/commit/f31e93700368f82cf22dfe4b00edcfbc448d60e4)
+- Configure installation of the library [`2358bb7`](https://github.com/dr8co/LiteString/commit/2358bb711ac08fe7fe64c4eec9597b30f3219a2c)
+- Disable testing with Homebrew GCC on macOS [`e3a6886`](https://github.com/dr8co/LiteString/commit/e3a688626420f58948d5e23d83836e66a050f8dd)
+- Upgrade attributes' compatibility with pre-C23 stds [`4551940`](https://github.com/dr8co/LiteString/commit/455194069c98edec59801c8274becb978b868258)
+- Create cmake multi-platform CI workflow [`49fc9ba`](https://github.com/dr8co/LiteString/commit/49fc9ba9a9fd06a67fe47f6251a24516c4cbf769)
+- Rename the operations test suite [`488d18a`](https://github.com/dr8co/LiteString/commit/488d18a477672bad89472494e79e974ae11aea3c)
+- Update the CI workflow [`ea08c96`](https://github.com/dr8co/LiteString/commit/ea08c96b388065fb0a1c6e25a8b341eae7ff1c4e)
+- Use smart pointers to manage `lite_string` resources [`b079f38`](https://github.com/dr8co/LiteString/commit/b079f383fe98bf83e8f3a9ae5e1bcb417a64b3dc)
+- Refactor for MSVC compatibility [`1bd6dc6`](https://github.com/dr8co/LiteString/commit/1bd6dc6497b9d06cd5dd046d4eb46a82c02eecb4)
+- Refactor CMakeLists.txt [`485e9c2`](https://github.com/dr8co/LiteString/commit/485e9c202286227bc00dc5b02dd6c12697b4f79f)
+- Eliminate redundant memory allocation by `string_cstr()` [`275d3a7`](https://github.com/dr8co/LiteString/commit/275d3a7ea3f8015f79f1242b10bf0ff52eaff1d0)
+- Update README.md sections [`91a16df`](https://github.com/dr8co/LiteString/commit/91a16df8b7d2d9af6361c8086b854eaf8dbbd75c)
+- Reserve enough space for null termination [`34b10d3`](https://github.com/dr8co/LiteString/commit/34b10d3d33b2fb071ad17145b0e5be3489edf32e)
+- Update README.md [`a957419`](https://github.com/dr8co/LiteString/commit/a9574199230c51430b6be8da0be937a554fc5f9f)
+- Update search tests [`0542dee`](https://github.com/dr8co/LiteString/commit/0542dee8a89ee59c20d2d3c21de8a463ca5befbf)
+- MSVC and Clang-cl compatibility [`01fc49f`](https://github.com/dr8co/LiteString/commit/01fc49fb9305a144f7b778ad9ed7b0ac9cacffe0)
+- Update behavior to always find empty strings in valid strings [`bf335cc`](https://github.com/dr8co/LiteString/commit/bf335cce3e53dad7796393ece8980ad8958fab63)
+- Hide the `lite_string` structure from the user [`3eb9395`](https://github.com/dr8co/LiteString/commit/3eb9395fffc40630417c17c4882ec570663abdf0)
+- Refactor examples [`460ad82`](https://github.com/dr8co/LiteString/commit/460ad826429ef166b6103c646a4a12a44d3a6f21)
+- Configure InnoSetup installer [`11ad197`](https://github.com/dr8co/LiteString/commit/11ad197ff68a49e0008af7e4a219861191c064e5)
+- Update the copyright notice [`d546fa9`](https://github.com/dr8co/LiteString/commit/d546fa96b7c1035562a90f30b4f2f13e211c9494)
+- Add an option to disable the 'restrict' keyword [`217227d`](https://github.com/dr8co/LiteString/commit/217227d92d7027c66f56c70a82b8a3127361f9ab)
+- Add README table of contents [`da4ef2b`](https://github.com/dr8co/LiteString/commit/da4ef2b7315351100a0ab517b3852e58bc4d2f71)
+- Refactor CMakeLists.txt [`0ad9231`](https://github.com/dr8co/LiteString/commit/0ad92311b6c9e45c158fafdd8a45f208d5d48bbf)
+- Set up tests [`c2d084c`](https://github.com/dr8co/LiteString/commit/c2d084c42f1ae429c9426f22724a8497c1bd4ec7)
+- Rename and refactor the general test suite [`7bc2df9`](https://github.com/dr8co/LiteString/commit/7bc2df9570d5575d33a93b819acc7e52d2ef0e2a)
+- Update examples' compatibility with MSVC [`d5a63eb`](https://github.com/dr8co/LiteString/commit/d5a63ebbf762fa0ae6893ca2e2219f2bf34d23d9)
+- Set up component install [`6d71fa1`](https://github.com/dr8co/LiteString/commit/6d71fa1e9dfe9105198aef784d360e8f58c83fa5)
+- Rename the search test suite [`622383c`](https://github.com/dr8co/LiteString/commit/622383c792135b304e72d38c9bc4a3f0ade27c0b)
+- Configure installation of version_info.txt [`2119ce1`](https://github.com/dr8co/LiteString/commit/2119ce1e7eb1e0673da59d89c5d9bdb2866beb07)
+- Rename the compiled library [`6a06f58`](https://github.com/dr8co/LiteString/commit/6a06f589be4a244cff5dba66ea9a9baf552a7605)
+- Update MSVC compatibility [`3097c3d`](https://github.com/dr8co/LiteString/commit/3097c3dc2640709f41f7d86a70fe7bd93ba9b0e7)
+- License the library under the MIT license [`121cf67`](https://github.com/dr8co/LiteString/commit/121cf67497ebef014d220980c911e964b0eb062c)
+- Apply appropriate function attributes [`fdfe4ed`](https://github.com/dr8co/LiteString/commit/fdfe4ed0d96cf5c0947402974d9babe570aa1c2d)
+- Eliminate redundant packaging in tests CI [`542e7e6`](https://github.com/dr8co/LiteString/commit/542e7e626e75d30a8cd354a8e47ab85579a45db2)
+- Fix CI workflow errors [`1b927b0`](https://github.com/dr8co/LiteString/commit/1b927b0cf22f65590b4f1ec5a14894b0706cb25a)
+- Refactor examples [`785ddca`](https://github.com/dr8co/LiteString/commit/785ddca1055c5303e55afb28e40b8a260c38b542)
+- Add README.md [`58f99e7`](https://github.com/dr8co/LiteString/commit/58f99e72b6fc0e3d286a35eabab83c439114f01e)
+- Refactor `string_new_cstr()` [`bc0757a`](https://github.com/dr8co/LiteString/commit/bc0757ac52d70d6abae0f4c82cb0833271b81cfd)
+- Enable sanitizers [`9a8000b`](https://github.com/dr8co/LiteString/commit/9a8000b9940fb94efdc31d5d1c7e00da9ceb369d)
+- Purge NSIS settings [`94ed4b0`](https://github.com/dr8co/LiteString/commit/94ed4b094fe4f07979464bae74a18fc60f361093)
+- Use bit manipulation to transform characters [`f6e1d3a`](https://github.com/dr8co/LiteString/commit/f6e1d3a1bd32228befe22f44c49e7cc7c3095e58)
+- Use logos with rounded corners [`6661584`](https://github.com/dr8co/LiteString/commit/66615844930d380609083ada9827412e7863b8ba)
+- Update examples' README.md [`d2ec3f2`](https://github.com/dr8co/LiteString/commit/d2ec3f256ae8e76db8074a16a1eb5f81ae7af5a8)
+- Expose GNU extensions [`07b4a3f`](https://github.com/dr8co/LiteString/commit/07b4a3ffb576127a9cce296fe0c1396687cd3449)
+- Configure examples [`22ca474`](https://github.com/dr8co/LiteString/commit/22ca4745e95304785369e486036d415311989ae3)
+- Rename the structure [`67d4e6b`](https://github.com/dr8co/LiteString/commit/67d4e6b8e33e2946ba10097764a3bbb269badd6d)
+- Update compatibility with MSVC [`dc2e5a4`](https://github.com/dr8co/LiteString/commit/dc2e5a403517fe975b3959653c7aa94e7c40bee7)
+- Update the examples' README.md [`64e6967`](https://github.com/dr8co/LiteString/commit/64e69673e5685a18dbe37f533e82311421f6987b)
+- Fix typos for optional execution paths [`fe97d66`](https://github.com/dr8co/LiteString/commit/fe97d66df68c1341292d8c8dc4d2fe6e2b621b01)
+- Update macro names [`36c2ed5`](https://github.com/dr8co/LiteString/commit/36c2ed564220c8d8efba348e173ca5ff7e728e9e)
+- Configure auto-changelog [`832a494`](https://github.com/dr8co/LiteString/commit/832a49455bd321522d53078646bab1c37b08ab9b)
+- Configure imgbot to optimize images [`8c4022d`](https://github.com/dr8co/LiteString/commit/8c4022d2219d360a60b2bb65312403b259ab82fd)
+- Fix -Wstatic-in-inline issues [`b2a55e2`](https://github.com/dr8co/LiteString/commit/b2a55e2596214e91b52cca3725a6a588fe9326dc)
+- Typecast pointers for C++ compatibility [`8a32290`](https://github.com/dr8co/LiteString/commit/8a322908e7ee171af4e8c7b81cf023c72e69a74f)
+- Add badges to README.md [`a30809a`](https://github.com/dr8co/LiteString/commit/a30809a6c250cbd07e29b487b836c4ef05f90ae8)
+- Enable testing with Homebrew GCC on macOS [`e00bf72`](https://github.com/dr8co/LiteString/commit/e00bf728c1a1e2241d0c34b58ea61a488afde1b1)
+- Update tests to conform with API changes [`30ba18f`](https://github.com/dr8co/LiteString/commit/30ba18fd1c40c64fcd2b1ece21e281894a2b4fb3)
+- Update boolean definitions [`18bbfc6`](https://github.com/dr8co/LiteString/commit/18bbfc6a7fe7f68763192462bab7c719877b1d3d)
+- Update compilation flags [`99d0a8a`](https://github.com/dr8co/LiteString/commit/99d0a8ad007e0bc7b9b5eee083e0f50911dc2aa6)
+- Ignore the build directory and the Doxyfile [`a88da48`](https://github.com/dr8co/LiteString/commit/a88da487372bec97fd77064afcdcd99f8a57f6bc)
+- Refactor sources for C++ and GTest compatibility [`1ef6f53`](https://github.com/dr8co/LiteString/commit/1ef6f5399f2c0e3e43c6651670c007026ac79dd2)
+- Use clang++-15 for CI C++ compilation [`ad8238e`](https://github.com/dr8co/LiteString/commit/ad8238e71c090798d1c5588828f250a371723581)
+- Define 'nullptr' for non-c23 compilers [`0d37ae5`](https://github.com/dr8co/LiteString/commit/0d37ae5167cd0a45ebda35cd98b230ab8697d653)
+- Update packing options [`db729ff`](https://github.com/dr8co/LiteString/commit/db729ff7aef2304a14830cbb7aefc1b3556240c7)
+- Update assets [`5a879b5`](https://github.com/dr8co/LiteString/commit/5a879b5ff71c8aaeffdcb34ca3a75e09a97b6ace)
+- Fix a typo [`d4baa9d`](https://github.com/dr8co/LiteString/commit/d4baa9d9a689a68fabaf346c922f3b833671194e)
+- Fix overflow issues [`20c2a84`](https://github.com/dr8co/LiteString/commit/20c2a848d164c2226cd22b6530f99a28eff07d60)
+- Add the project changelog [`96d4fa6`](https://github.com/dr8co/LiteString/commit/96d4fa67ca3613fd21661a39aa936e94239ced75)
+- Add additional media assets [`d58defb`](https://github.com/dr8co/LiteString/commit/d58defb5e56bae8d5b7c8bff59c0a3237b129753)

CMakeLists.txt

@@ -1,7 +1,7 @@
 cmake_minimum_required(VERSION 3.28)
 
 project(LiteString
-        VERSION 0.1.0
+        VERSION 1.0.0
         DESCRIPTION "A lightweight byte string library for C"
         HOMEPAGE_URL "https://github.com/dr8co/LiteString"
         LANGUAGES C CXX)

lite_string.h

@@ -21,8 +21,8 @@
 #pragma once
 
 // Library version
-#define _lite_string_major 0L ///< LiteString major version.
-#define _lite_string_minor 1L ///< LiteString minor version.
+#define _lite_string_major 1L ///< LiteString major version.
+#define _lite_string_minor 0L ///< LiteString minor version.
 #define _lite_string_patch 0L ///< LiteString patch version.
 
 /// The LiteString version as a single integer.