qdeslandes/yall

Subsystem based C logging library.

yall's Issues

Color problem when many warning logs

Empty the log files on each application run

Remove file in create_subsystem(), add a flag in struct yall_subsystem to find out if the file should be deleted on create but do not use it now (subsystem creation will be to heavy will this flag).

Improve custom function call system

• C++ version ?
• Buffer size ? Let the caller define its own buffer size through malloc
• Carriage return ?
• Indent each line
• Possibility to add text on the first line

Find a way to use _Atomic and other on Windows

This is not useful, as windows provides atomic CAS through standard variable and other atomic primitives, which is sufficient.

Fix sonar warnings

Fix errors in class name on log display

Function / class name sometimes show the return type of the class.

YALL_MSG_LEN is not accessible from outside the library

message.h should be included inside yall.h

Fix broken sonar badges

Install target copy README.md and LICENSE to /usr/include

Build and deploy on release and debug

Access to yall headers from Visual Studio

yall headers are not visible inside Visual Studio (because they are not part of the project inside CMake).

Create macro to convert char * to std::string

Need to convert char * to std::string

Show the class and method name instead of the method name

The purpose is to have :
appTest ::: NOTICE :: TestClass::main :: 2017-01-26 17:45:47 : Starting application...
instead of :
appTest ::: NOTICE :: main :: 2017-01-26 17:45:47 : Starting application...

Add a debug mode to display useful informations

This mode should be enabled in run time.

Create non length-limited log messages

Change library license

Current license is GPLv2. The problem is that a closed sources project could not use the library, which is blocking. The currently most appropriate license is MIT.

Set subsystem management thread safe

Count references to the library

A problem occurs if a client closes yall before the other client have finished :

A: yall_init();
B: yall_init();
B: yall_close();
A: YALL_ERR(); -> Library is closed !

Refactor header generation

Header format should be customizable to allow different configurations, in a printf manner :
\s :: \d :: \f : will generate <subsystem> :: <date> :: <function> as header.

Avoid opening and closing the log file on each log

Restore tests for generate_std_msg()

Currently, tests for generate_std_msg() are disabled because of a failure on Windows, they need to be restored.

Load config from a file

Possibility to load the subsystems configuration from a file

Create a C++ wrapper with a log class

YALL_CALL_LOG does not add newline after the content

Check coding conventions on Linux during CI

• Use Perl script to check coding guidelines
• Check trailing whitespaces

It appears the library crash when the message buffer is overflowed

Conditions : Win32
Version : 1.1.0 Release

Check if library is initialized on logging

Currently, YALL_DEBUG() and such macros can be called even if the library is not initialized.

Fix Sonar's error about localtime_r not use

Message's buffer overrun on YALL_CALL_LOG when no header set

Show the subsystems tree

Create a function which output the subsystem tree :

main
  |-> test
          |-> subtest
  |-> other

Write unit testing for a coverage up to 50%

Add flag to disable unit tests build on CMake

Follow Linux libraries naming conventions

Ex: libyall.so.1.2

Create a function to convert error code to string

This function must map each error code (yall/errors.h) to a string.

Factorize subsystem check (log level, status) on yall_log and yall_call_log

Create message queue to avoid locking

Create a lock free message queue which avoid locking the console or the file.

• This queue must be emptied on closing.
• Add message when writer thread is closed.

TODO :

• Write unit tests

Set fixed size for subsystem name

appTest ::: NOTICE :: main :: 2017-01-26 17:45:47 : Starting application...

Set fixed name length for subsystem name ("appTest" here). The style of the generated output should be better.

The flag which define debug info is missing on Windows (/Z7)

Create a log viewer

Create an application which will read a log file and a configuration, and show the subsystems tree and each log message.

Create a MSVC12 build

TODO :

• Build Criterion (unit testing) for MSVC 12 : failed. Boxfort which is a depedency of Criterion does not support MSVC < 14
• Run MSVC 12 build on AppVeyor

Fix update_subsystem() which does not clean pointers (next, parent, ...)

This issue can leads to circling reference between two subsystems.

Create a Notepad++ color scheme

Set debug postfix to "d" on debug builds

Through set(CMAKE_DEBUG_POSTFIX d)

Create a "default" subsystem in case of error

This subsystem will be defined inside the library and will be used in case of error, if a requested subsystem is not found. It should log data from debug to emerg in a specific file.

Allow subsystem complete activation / desactivation easily

• Are the childs disabled ?
• Macro ? yall_disable(subsys) / yall_enable(subsys) ?

Fix SonarCloud bugs

SonarCloud found a bug.

Replace subsystems linked list

The subsystems linked list is not the best way to manage the subsystems as it triggers cache misses when the library try to retrieve a subsystem. Using a plain array would be better, but we have to keep the subsystems hierarchy intact.

Issue #42 would work on the same parts of the code.

Callback functions

Implement callback function for each subsystem, on each log level.
This will allow to call a specific custom function on each subsystem log for each log level (to open a confirmation popup for example).

UPDATE : This a more an "Error management" feature, than a "Logging" feature. It is currently out of scope.

Rewrite README.md

Clean README.md, set only useful informations and write library documentation inside the GitHub wiki.

Show message line on log output

Instead of :
appTest ::: EMERGENCY :: main :: 2017-01-27 15:41:51 : ApplicationManager failed to initialize
get :
appTest ::: EMERGENCY :: main:186 :: 2017-01-27 15:41:51 : ApplicationManager failed to initialize