hulkiedo17 / counter

counter - code line counter in source files of C projects

What is this?

counter - is a program that counts lines in files in the current directory. There is also the possibility of recursive access to directories, that is, lines will be counted in files in subdirectories as well.

How to launch

This program works only on linux.

Required tools: gcc, cmake, make, bash

Firstly, you need to download repository:

$ git clone https://github.com/hulkiedo17/counter.git

To compile program type this commands:

$ cd counter
$ ./build.sh

Or use cmake directly:

$ mkdir build && cd build
$ # or if you want release version, change option to -DCMAKE_BUILD_TYPE=RELEASE
$ cmake -DCMAKE_BUILD_TYPE=DEBUG -DCMAKE_INSTALL_PREFIX=/usr/local/ ..
$ make
$ sudo make install

After this steps, you can run program by typing this command:

$ counter

Options

Enter the -h option to check all program options:

$ counter -h
usage: counter [options...]

options:
	-v        - prints program version
	-h        - prints this help message
	-o        - prints files and paths that counted
	-r        - do not use files in nested directories
	-s        - do not count the empty lines in files
	-z        - do not show emply files
	-t        - do not show total lines count of files
	-e        - use skip pattern from environment variables
	-c        - use count pattern from environment variable
	-p [path] - specifying another directory for counting lines in files
	-f [file] - specifying file to count lines
	-F [file] - ignore specified file (note: path to file will be discarded)
	-D [dir]  - ignore specified directory (note: path to dir will be discarded)

Also, you can check build options, by typing -h to build script:

$ ./build.sh -h
usage: ./build.sh [options...]

options:
	-d - compile and install debug version
	-r - compile and install release version
	-c - delete compiled object files
	-h - print help message

it is recommended to use build script from the main repository directory, not a build or other nested directories.

Environment variables

You can also specify environment variables to specify file and directory comparsion patterns.

Example:

# in this var you specify the names of directories that are skipped in count, and separating this with '|' symbol.
export DIR_SKIP_COUNTER=".|build|bin"
# in this var you specify the file extensions or their names that are skipped in count, and separating this with '|' symbol.
export FILE_SKIP_COUNTER=".md|.txt|LICENSE|.out"

# in this var you specify the names of directories that and only they will participate in the count, and separating this with '|' symbol.
export DIR_COUNT_COUNTER="src|include"
# in this var you specify the file extensions or their names and only they will participate in the count, and separating this with '|' symbol.
export FILE_COUNT_COUNTER=".c|.h|.sh|.mk"

TODO list

• remake program structure
• add new options
• add config file and environment variables
• add to -D option basename() function to discard path to dir
• add -C option which excludes configuration files from the count
• add option to output program version
• add option with excludes comments in source files from the count
• add -V option to show only filenames and count