femto - project showcase

Features:

• open, create, save text files
• navigation
• edition

Bugs:

• bad line wrapping
• unknown escape sequences were printed to screen (e.g. Shift+Arrow key)
• rare unhandeld glitches while editing

Personal project outcome:

• active C project to gain more experience
• zero dependencies
• text editors have a lot of feature potential (highlighting, tabs, views, macros,…)
• coping with the terminal’s raw mode can be handy for further projects

Femto consists of seven components:

• update output on terminal
• generate status bar

A simple data+length structure with functions to write more convenient to the data:

typedef struct
{
    char *data;
    unsigned length;
}Buffer;

This struture is currently only used by the screen module as framebuffer.

• enable/Disable Raw mode
• determine terminal resolution
• determine cursor position
• get user input and replace it with a pseudo key if compound

It’s purpose overlaps with the screen module. Both are somehow manipulating the terminal’s behaviour.

FileIO uses the filename given in the session object and stores the file’s content into it.

Handle dialogs including getting the users input, generating the right status bar and trigger a refresh. It comes with two dialogs:

• safe file
• quit (do you really discard unsaved changes?)

Internally it has a generic dialog function which could be used to add more.

The helper has two major responisibilities:

• logging
• provide shortcuts for often used mathematical functions

The logger has a printf alike formatter function which automatically includes the module name and line number where the logger gets called. This is accomplished by hiding the real formatter function behind a preprocessor directive which adds the module name and line number in place.

Cilicon is a syntactic sugar library which ‘frames’ a unit test using concepts like ‘it’, ‘suite’ and ‘expect_…’ inspired by ruby’s rspec.

Each C module has it’s own test suite represented in an extra test file. For example the module buffer has it’s own test_suite_buffer with the file buffer_test.c:

void test_create_buffer()
{
    TEST_IT_NAME("creates a buffer");

    Buffer *buf = fe_create_buffer();
    if( ! expect_not_null( buf )) return;

    fe_free_buffer(buf);
    
    TEST_OK
}

void test_append_to_buffer()
{
    TEST_IT_NAME("appends to a buffer");
    const char *test_string = "const char *test_string";
    Buffer *buf = fe_create_buffer();
    
    if( ! expect_not_null( buf )) return;

    fe_append_to_buffer(buf, test_string, strlen(test_string));
    
    if( ! expect_b_eq( (void*) test_string, buf->data, strlen( test_string ), buf->length  )) goto cleanup;

    TEST_OK;

cleanup:
    fe_free_buffer(buf);
}

void test_suite_buffer()
{
    TEST_SUITE_NAME("Buffer");

    test_create_buffer();
    test_append_to_buffer();
}

Which outputs the following on success:

---- Buffer ----
it creates a buffer                      OK
it appends to a buffer                   OK

ALL PASSED

And on failure:

---- Buffer ----
it creates a buffer                      OK
it appends to a buffer                   FAIL
Expected equal buffers, got unequal.

1 of 2 expects failed.
FATALITY