Programming 1 Final Project [December 2024]

A basic hotel reservation system made purely in C with the help of standard libraries and our own libui non-ncurses library for the user input/ output.

Repo Structure

Item	Purpose
src/	hotel-specific files
include/	our libraries that can be used in other projects
CMakeLists.txt	compilation helper with CMake
.devcontainers	barebones devcontainer for use in GitHub CodeSpaces

Project Details

Givens & Expectations

You may find the original instructions PDF by the TA here, though it contains unclear instructions.

Extra additions and clarifications to the provided project instructions & requirements.

This program expects:

• being run on a single thread - uses non-re-entrant functions, provides no measures against data-races
• being compiled for a Unix(-like) or Windows environment
• being run from a VT100 compatible terminal emulator
• only one instance/ process of itself running from per directory
• all files are present in the same directory as the executable file
• all files are accessible to the user or process with no external locks (advisory or not) on the file
• all files' contents are valid and contain no conflicting or nonsensical information

The user expects

• being able to undo any previous action or return to a previous menu with keyboard shortcuts for either
• input being validated as it is being typed, and verified after it is entered
• only one reservation per room
• the program picks the first available room for the user based on the inputted criteria as per the instructions
• the program will write all the data to the files as it exits

Contributors

David Michael

Mina Youssef

Adham Gaweesh

Mohamed Ashraf

Youssef Samy

Code Conventions & Guidelines

This section draws inspiration from The Linux Kernel Coding Style for v4.10, v6.8 and the Style Guide for Python Code PEP-8.

Aside from a few additions and using 4 spaces for indentation rather than 8, this codebase should mostly be compliant with The Linux Kernel Coding Style for v6.8.

C Standard

The code generated must be compatible with all C standards starting with C89/90, and leave little to no leeway for compiler extensions.

Encoding of Source Code

As much of the code as possible should be in ASCII, and most of the elements of the code must be in ASCII (identifiers, keywords, etc). Non-ASCII UTF-8 characters are acceptible only if run-time compatibility is taken into account.

Identifier Naming & Declaration

Case

Type	Case
macro, const	UPPER_SNAKE
variable, function, typedefs	lower_snake
struct, union	TitleCase

Structures

ONLY typedef a struct IF YOU WILL ABSTRACT AWAY ALL ACCESS TO ITS MEMBERS WITH (SETTERS/ GETTERS)-LIKE FUNCTIONS.

You may use TitleCase or lower_snake_t for a typedefed struct.

General example: stdio.h's FILE and its functions (fopen(), fgets(), etc)

In-code example: management.h's room_t and its functions (get_price_per_night())

Type Indication

For identifiers with an ambiguous type, you should add a postfix indicating the type. For example:

• NEWLINE_C instead of NEWLINE for a macro of type char
• size_t instead of size for a typedef
• int *arr instead of int* arr when declaring pointers
• *student_name instead of *student_name_s for a string variable pointing to a name; it is self-explanatory

Indentation

Strictly use the space character instead of the tab character. Your IDE can be configured to insert spaces when the TAB key is pressed. Use 4 spaces per indendation level.

Comments

Use the backwards compatible /* comment */ for in-line comments. Do not add redundant or obvious comments. Use common sense with placement of in-line comments. Use self-explanatory identifiers and functions rather than raw constant values.

For multi-line comments, use the following convention:

/*
 * This is a
 * multi-line
 * comment.
 */

Function and Control-flow Bodies

Function Braces

Use the style as per the following example

size_t strlen(char *str)
{
    size_t len;
    ...
    return len;
}

and NOT

size_t strlen(char *str) {
    size_t len;
    ...
    return len;
}

Condition & Loop Bodies

Conditions in brackets should be lead by a space after the control-flow keyword, ex. if (condition) rather than if(condition). Single-statement bodies

if (condition)
    statement1;

Multi-statement bodies

while (condition) {
    statement1;
    statement2;
}

switch-case statements

switch (expr) {
case a:
    statement1;
    break or return;

if-else

if (condition1) {
    statement1;
} else if (condition2) {
    statement2;
} else {
    statement3;
}

do-while

do {
    statement1;
} while (condition);

Path Name Slashes

Use forward slashes / unless compatibility with a supported Windows version requires use of a backward slash \.

Newline Indicator (in source code, not strings)

Optionally prefer CRLF (or \r\n) by default, and LF (or \n) only for strict Unix compatibility situations. Manage newline indicators using .gitattributes instead of using your IDE.