Initial commit

This commit is contained in:
Randy Jordan 2025-07-10 18:51:28 -05:00
commit 5825c71eb6
Signed by: Randy-Jordan
GPG Key ID: 153FF450FDC74D1A
9 changed files with 297 additions and 0 deletions

21
LICENSE Normal file
View File

@ -0,0 +1,21 @@
MIT License
Copyright (c) [year] [fullname]
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

76
Makefile Normal file
View File

@ -0,0 +1,76 @@
# Compiler Flags
CC := gcc
CFLAGS := -g -Wall -Wextra -Werror -pedantic -fsanitize=address,undefined -fno-omit-frame-pointer
# Directory variables
LIBDIR := lib
OBJ := obj
INC := include
SRC := src
TEST := tests
# Filepath Pattern Matching
LIB := $(LIBDIR)/lib.a
SRCS := $(wildcard $(SRC)/*.c)
OBJS := $(patsubst $(SRC)/%.c, $(OBJ)/%.o, $(SRCS))
TESTS := $(wildcard $(TEST)/*.c)
TESTBINS := $(patsubst $(TEST)/%.c, $(TEST)/bin/%, $(TESTS))
# Commands must be labeled PHONY
.PHONY: all release clean test
# Compiler Release Flags
release: CFLAGS := -Wall -Wextra -Werror -pedantic -fsanitize=address,undefined -fno-omit-frame-pointer -O2 -DNDEBUG
release: clean $(LIB)
# Target for compilation.
all: $(LIB)
# Target / Dependencies
$(LIB): $(OBJS) | $(LIBDIR)
$(RM) $(LIB)
ar -cvrs $@ $^
$(OBJ)/%.o: $(SRC)/%.c $(SRC)/%.h | $(OBJ)
$(CC) $(CFLAGS) -c $< -o $@
$(OBJ)/%.o: $(SRC)/%.c | $(OBJ)
$(CC) $(CFLAGS) -c $< -o $@
$(TEST)/bin/%: $(TEST)/%.c $(LIB) | $(TEST)/bin
$(CC) $(CFLAGS) $< $(LIB) -o $@
# Make directories if none.
$(LIBDIR):
mkdir $@
$(INC):
mkdir $@
$(OBJ):
mkdir $@
$(TEST)/bin:
mkdir $@
# Run the tests in the bin folder and track results
test: $(LIB) $(TEST)/bin $(TESTBINS)
@SUCCESS_COUNT=0; FAILURE_COUNT=0; \
for test in $(TESTBINS); do \
./$$test; \
EXIT_CODE=$$?; \
TEST_NAME=$(notdir $$test); \
if [ $$EXIT_CODE -eq 0 ]; then \
echo "\033[0;32m$$TEST_NAME: EXIT CODE: $$EXIT_CODE (SUCCESS)\033[0m"; \
SUCCESS_COUNT=$$((SUCCESS_COUNT + 1)); \
else \
echo "\033[0;31m$$TEST_NAME: EXIT CODE: $$EXIT_CODE (FAILURE)\033[0m"; \
FAILURE_COUNT=$$((FAILURE_COUNT + 1)); \
fi; \
done; \
echo "\n\nTests completed"; \
echo "SUCCESS: $$SUCCESS_COUNT"; \
echo "FAILURE: $$FAILURE_COUNT";
clean:
$(RM) -r $(LIBDIR) $(OBJ) $(TEST)/bin/

25
README.md Normal file
View File

@ -0,0 +1,25 @@
# SV
## Description
String View implementation written in C.
## Table of Contents
- [Description](#description)
- [Features](#features)
- [Usage](#usage)
- [Credits / Resources](#credits--resources)
- [License](#license)
## Features / TODOS
## Usage
make <br>
make test
## Credits / Resources
[Mongoose Webserver](https://github.com/cesanta/mongoose)<br>
[Tsoding Daily](https://github.com/tsoding/sv)<br>
## License
This project is licensed under MIT - see the [LICENSE](LICENSE) file for details.

80
include/except.h Normal file
View File

@ -0,0 +1,80 @@
#ifndef EXCEPT_INCLUDED
#define EXCEPT_INCLUDED
#include <setjmp.h>
struct Exception {
const char *reason;
};
typedef struct Exception Exception;
struct ExceptFrame {
struct ExceptFrame *prev; // Exception Stack
jmp_buf env; // Enviroment Buffer
const char *file; // Exception File
int line; // Exception Line
const Exception *exception; // Exception Reason
};
typedef struct ExceptFrame ExceptFrame;
// Exception States
enum { EXCEPT_ENTERED=0, EXCEPT_RAISED, EXCEPT_HANDLED, EXCEPT_FINALIZED};
void except_raise(const Exception *e, const char *file,int line); // Raise exceptions
// External declarations
extern ExceptFrame *except_stack; // Global exception stack
extern const Exception assert_failed; // Forward declaration for assert.
extern void asserted(int e);
#ifdef NDEBUG
#define ASSERTED(e) ((void)0)
#else
#define ASSERTED(e) ((void)((e)||(RAISE(assert_failed),0)))
#endif
// Raise an Exception.
#define RAISE(e) except_raise(&(e), __FILE__, __LINE__)
// Reraise the currect exception.
#define RERAISE except_raise(except_frame.exception, \
except_frame.file, except_frame.line)
// Switch to the previous exception frame and return.
#define RETURN switch (except_stack = except_stack->prev,0) default: return
// Start a try block.
#define TRY do { \
volatile int except_flag; \
ExceptFrame except_frame; \
except_frame.prev = except_stack; \
except_stack = &except_frame; \
except_flag = setjmp(except_frame.env); \
if (except_flag == EXCEPT_ENTERED) {
// Handle specific example.
#define EXCEPT(e) \
if (except_flag == EXCEPT_ENTERED) except_stack = except_stack->prev; \
} else if (except_frame.exception == &(e)) { \
except_flag = EXCEPT_HANDLED;
// Catch all other exceptions.
#define ELSE \
if (except_flag == EXCEPT_ENTERED) except_stack = except_stack->prev; \
} else { \
except_flag = EXCEPT_HANDLED;
// Execute finalization code.
#define FINALLY \
if (except_flag == EXCEPT_ENTERED) except_stack = except_stack->prev; \
} { \
if (except_flag == EXCEPT_ENTERED) \
except_flag = EXCEPT_FINALIZED;
// End Try block.
#define END_TRY \
if (except_flag == EXCEPT_ENTERED) except_stack = except_stack->prev; \
} if (except_flag == EXCEPT_RAISED) RERAISE; \
} while (0)
#endif

23
include/sv.h Normal file
View File

@ -0,0 +1,23 @@
#ifndef SV_INCLUDED
#define SV_INCLUDED
#include <stddef.h>
// macros
#define SV(s) sv_str(s)
#define SV_NULL sv_strn(NULL, 0)
// printf macros
#define SV_FMT "%.*s"
#define SV_ARG(sv) (int) (sv).len, (sv).buf
struct String_View{
size_t len; // String lenght
const char *buf; // String data
};
typedef struct String_View SV;
SV sv_str(const char *s);
SV sv_strn(const char *s, size_t len);
#endif

30
src/except.c Normal file
View File

@ -0,0 +1,30 @@
#include "../include/except.h"
#include <stdlib.h>
#include <stdio.h>
ExceptFrame *except_stack = NULL; // Global exception stack.
const Exception assert_failed = { "Assertion Failure!" }; // If ASSERT fails.
void except_raise(const Exception *e, const char *file,int line) {
// An exception was raised, grab the exception stack.
ExceptFrame *p = except_stack;
asserted(e != NULL); // Ensure exception pointer is not NULL
if (p == NULL) { // Uncaught Exception
const char *msg = e->reason ? e->reason : "Uncaught Exception!";
fprintf(stderr,"\033[31m%s | Address: 0x%p | Raised at %s@%d \033[0m" ,msg,(void *)e,file,line);
fflush(stderr);
abort();
}
// Set the exception details to the current frame.
p->exception = e; // Exception reason
p->file = file;
p->line = line;
// Move to the previous frame in the stack.
except_stack = except_stack->prev;
// Jump to the saved context environment.
longjmp(p->env, EXCEPT_RAISED);
}
void asserted(int e) {
ASSERTED(e);
(void)e;
}

12
src/sv.c Normal file
View File

@ -0,0 +1,12 @@
#include "../include/sv.h"
#include <string.h>
SV sv_str(const char *s){
SV str = {s == NULL ? 0 : strlen(s), (char *)s};
return str;
}
SV sv_strn(const char *s, size_t len){
SV str = {len, (char *) s};
return str;
}

15
tests/01_sv_str.c Normal file
View File

@ -0,0 +1,15 @@
#define DEBUG
#include "../include/sv.h"
#include "../include/except.h"
#include <stdlib.h>
#include <string.h>
int main(void){
char *str = "Hello World";
SV vstr = sv_str(str);
ASSERTED(strcmp(str, vstr.buf) == 0);
ASSERTED(strlen(str) == vstr.len);
return EXIT_SUCCESS;
}

15
tests/02_sv_strn.c Normal file
View File

@ -0,0 +1,15 @@
#define DEBUG
#include "../include/sv.h"
#include "../include/except.h"
#include <stdlib.h>
#include <string.h>
int main(void){
char *str = "Hello World";
SV vstr = sv_strn(str,strlen(str));
ASSERTED(strcmp(str, vstr.buf) == 0);
ASSERTED(strlen(str) == vstr.len);
return EXIT_SUCCESS;
}