https://github.com/antonako1/atrc

ATRC resource/configuration file library
https://github.com/antonako1/atrc

configuration-files cpp library linux resource-file windows

Last synced: 7 days ago
JSON representation

ATRC resource/configuration file library

• Host: GitHub
• URL: https://github.com/antonako1/atrc
• Owner: Antonako1
• License: mit
• Created: 2024-05-12T14:23:05.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2025-01-26T20:57:24.000Z (24 days ago)
• Last Synced: 2025-01-26T21:18:46.745Z (24 days ago)
• Topics: configuration-files, cpp, library, linux, resource-file, windows
• Language: C++
• Homepage: https://antonako1.github.io/ATRC/docs/index.htm
• Size: 3.72 MB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# ATRC resource/configuration file library for C/C++

Configuration file library made with C++17, with a wrapper for C

## Documentation

See [.\docs\index.htm](https://antonako1.github.io/ATRC/docs/index.htm)

## Use with CMake

```bash

# Define the path to the ATRC configuration file

set(CMAKE_PREFIX_PATH "${CMAKE_SOURCE_DIR}/ATRC_2.2.0/cmake")

# Find ATRC library using its config file

find_package(ATRC REQUIRED)

# Define project

project(MyProject)

add_executable(MyProject src/main.cpp)

# Include header files

target_include_directories(MyProject PRIVATE ${ATRC_INCLUDE_DIR})

```

## Example program

```cpp

#include 

using namespace atrc;

int main()

{

    ATRC_FD fd = ATRC_FD("file.atrc");

    if (!fd.CheckStatus()) {

		std::cout << "File parsed unsuccesfully!" << std::endl;

		return 1;

	}

    std::cout << fd["var_name"] << std::endl;

    return 0;

}

```

## Example resource file

```conf

#!ATRC

# define variable

%var_name%=value

# define private variable

<%priv_var>=value

# define block

[block_name]

# define key

key=value

# reference variables

reference=variable values are: %var_name%, %priv_var%

# output: "variable values are: value, value" 

# insert variables

insert=insert a variable here: %*%

# insert whitespaces

whitespace=&whitespaces&

# output: " whitespaces "

# insert reserved char

reserved=reserved characters: \%, \&, \#

# output: "reserved characters: %, &, #"

# insert variables in a sequence. These start counting from 0

insert2=insert second variable here: %*1% and first one here: %*0*

# Preprocessor tags:

# Ignore following amount of rows

#.IGNORE=

#.IGNORE=1

THIS LINE IS IGNORED

# Comparisons. See docs for all values to use here

#.IF LINUX AND WINDOWS OR MACOS

user_info=Linux and Windows or MacOS in use!

#.ELIF LINUX AND X86

user_info=32 bit Linux!

#.ELSE

user_info=None

#.ENDIF

```

## Building & Running

```sh

    # Linux

    cmake --preset linux-x64-debug -B./out/linux-x64-debug/build -DCMAKE_BUILD_TYPE=Debug -DCMAKE_TOOLCHAIN_FILE=./cmake/toolchain-linux-x64.cmake -DATRC_BUILD_TESTS=ON && cmake --build ./out/linux-x64-debug/build --config Debug --target run_tests 

    # VS

    # 32-bit

    cmake -S . -B out\win_32 -DCMAKE_BUILD_TYPE=Debug -G "Visual Studio 17 2022" -A Win32 & cmake --build out\win_32 & c:\Users\anton\Documents\GitHub\ATRC\out\win_32\ATRC.Test\Debug\ATRC.Test.exe    

    # 64-bit

    cmake -S . -B out\win_64 -DCMAKE_BUILD_TYPE=Debug -G "Visual Studio 17 2022" -A x64 & cmake --build out\win_64 & c:\Users\anton\Documents\GitHub\ATRC\out\win_64\ATRC.Test\Debug\ATRC.Test.exe    

    # Create release package

    # Requires: debian, 7z, Windows build tools, Strawberry Perl, HTML Help Workshop

    .\scripts\build_and_package.bat

```