/reflag

Primary LanguageCMIT LicenseMIT


Logo

REFLAG

A modern redefinition of flags in C programming. You can define
your flags as enum objects and enjoy the abstraction. It is minimal,
fast and reusable.

Table of Contents
  1. About
  2. Getting Started
  3. Usage
  4. Structure
  5. API
  6. Contributing
  7. License
  8. Contact
  9. Acknowledgments

About

C Programming might not be beginner-friendly, especially when it comes to bitwise operations and flags, which are basically ones and zeros.

With flags one can:

  • configure a function as wished
  • control the program flow
  • make the code more dynamic

I assume you don't want to deal with bitwise operations in flagging, me neither. Or maybe you want to just level up your program. I implemented a brand new data structure so that you don't have to and here's why:

It can:

  • be useful at debugging because it has a print method
  • hold the names of enumeration variables
  • be easily extended because it is created in OOP-like style

Of course, this has still thousand problems. I'll be testing and developing more in the near future. You may also suggest changes by forking this repo and creating a pull request or opening an issue. Thanks to all the people have contributed to expanding this template!

(back to top)

Built With

Here are the dependencies:

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <dirent.h>

(back to top)

Getting Started

You can follow the next instructions for setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

These are the list of things you need to install:

Installation

All you need is to clone the repo. Here's the code:

git clone https://github.com/yamaceay/reflag.git
cd reflag

(back to top)

Structure

  • (means the content of the folder can be changed)

  • src (Source files)

  • include (Header files)

  • test (Test files)

    • my-test.c
    • your-test.c

  • output (Output)

    • my-test
    • your-test

  • input (Input)

    • all.h (Don't modify)
    • my-enum.txt
    • your-enum.txt

  • CMakeLists.txt (Build & Run Configurations)

  • Other files

(back to top)

API

API: TABLE OF CONTENTS
  1. Flag (Flag.h)
    • Flag - Attributes
    • Flag - Methods
  2. Renum (Renum.h)
    • Renum - Attributes
    • Renum - Methods

Flag (Flag.h)

Flag - Attributes

Attributes Type Description
__flags uint32_t Stores the flags as an unsigned integer value
__names char * (optional) Renames the flags for printing purposes

Flag - Methods

Methods Type Arguments Description
init void char *names Initializes a flag object
get uint32_t void *_self Returns the __flags
names char * void *_self Gets the names attribute
 set_names  void void *_self Sets the names attribute
print void void *_self Prints the actual state of flag (optionally renamed)
is bool void *_self, uint32_t aFlag Checks if the new flag has been already set (using bitwise AND)
set void void *_self, uint32_t aFlag Adds the new flag to the flag (using bitwise OR)
reset void void *_self, uint32_t aFlag Removes the new flag from the flag (using bitwise OR and bitwise NOT)

Renum (Renum.h) extends Flag

Renum - Attributes

Attributes Type Description
flag Flag Extends flag. Methods names(...), set_names(...), print(...) and get(...) can be directly accessed by Renum instance (self->print(...) equivalent to self->flag.print(...))
__len uint32_t Defines the number of items in renum

Renum - Methods

Methods (@Override) Type Arguments Description
init void char *names, uint32_t len Initializes a renum object
is bool void *_self, uint32_t aRenum Checks if the new renum is already set
any bool void *_self, uint32_t size, ... Checks if any of renums are already added (renums are given as parameter to Flag.is(...))
all bool void *_self, uint32_t size, ... Checks if all renums have been already added (renums are given as parameter to Flag.is(...))
set void void *_self, uint32_t aRenum Sets the new renum (renum is given as parameter to Flag.set(...))
set_all void void *_self, uint32_t size, ... Sets the given renums (renums are given as parameter to Flag.set(...))
reset void void *_self, uint32_t aRenum Removes the new renum (renum is given as parameter to Flag.reset(...))
reset_all void void *_self, uint32_t size, ... Removes the given renums (renums are given as parameter to Flag.reset(...))

(back to top)

Usage

For development and testing purposes, you need to follow the steps below:

  1. input: Create the enum by writing a text file in input directory your-enum.txt and list as follows:
    your_item_1
    your_item_2
    your_item_3
    your_item_4

which will create the following enum in the Step 3:

typedef enum your_enum {
    your_item_1 = 1,
    your_item_2 = 2,
    your_item_3 = 4,
    your_item_4 = 8
} your_enum;

  1. test: Testing file should be included in test directory and has a name your-test.c

  2. CMakelists.txt:

    // list of file names separated by ;
set(test_files my1 ; my2 ; *your*)

  3. Terminal: Run the following code:

    cd reflag # if you did not navigate to the project
cmake .

    As the result, you can now run the test output file using:

    ./output/*your*-test

(back to top)

Contributing

Contributions are what make this community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/your_feature)
  3. Commit your Changes (git commit -m 'Add some your_feature')
  4. Push to the Branch (git push origin feature/your_feature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Yamac Eren Ay - LinkedIn Account

Project Link: https://github.com/yamaceay/reflag

(back to top)