Skip to content
Merged
Show file tree
Hide file tree
Changes from 18 commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
17e7f30
chore: update .gitignore to include additional directories and file t…
bialger Sep 5, 2025
ac63f0c
chore: update CI workflow to use 'ovum' targets
bialger Sep 5, 2025
4bbd4e4
docs: add build instructions, code of conduct, and coding guidelines
bialger Sep 6, 2025
88ff9fa
chore: add .clang-format and .clang-tidy configuration files
bialger Sep 6, 2025
62c0cae
chore: rename project to 'ovum' and update related configurations
bialger Sep 6, 2025
7fdd857
docs: enhance README.md with detailed language features and nullabili…
bialger Sep 7, 2025
26f3965
docs: add CODEBASE_STRUCTURE.md and CONTRIBUTING.md for project guide…
bialger Sep 7, 2025
ba0366d
refactor: modularize CMake configuration by separating compiler optio…
bialger Sep 7, 2025
bb80c35
docs: update CODEBASE_STRUCTURE.md to clarify directory purposes and …
bialger Sep 7, 2025
38d3b59
refactor: reorganize test structure and implement ProjectIntegrationT…
bialger Sep 7, 2025
7e802dc
docs: enhance README.md with comprehensive design philosophy and cont…
bialger Sep 7, 2025
d395159
docs: update README.md to include nullable type support for primitive…
bialger Sep 8, 2025
24957a2
docs: update README.md to reflect changes in variable declaration key…
bialger Sep 8, 2025
6125d43
docs: expand project documentation with build instructions and refere…
bialger Sep 8, 2025
3b69955
docs: update README.md and reference documents for section renumberin…
bialger Sep 8, 2025
c0f780f
docs: revise README.md and code examples for clarity and consistency
bialger Sep 8, 2025
0411684
docs: expand built-in types documentation with detailed reference for…
bialger Sep 8, 2025
8817c3b
docs: update primitive types and syntax documentation for clarity
bialger Sep 8, 2025
711a7ee
docs: update CODE_OF_CONDUCT.md, CODEBASE_STRUCTURE.md, CODING_GUIDEL…
bialger Sep 9, 2025
9f679ce
docs: update code examples and reference documentation for clarity an…
bialger Sep 9, 2025
ab13611
fix: update contact email in CODE_OF_CONDUCT.md for reporting incidents
bialger Sep 9, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
87 changes: 87 additions & 0 deletions .clang-format
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
---
Language: Cpp
BasedOnStyle: Google
AccessModifierOffset: -2
AlignAfterOpenBracket: Align
AlignConsecutiveAssignments: false
AlignConsecutiveDeclarations: false
AlignOperands: true
AlignTrailingComments: true
AllowShortBlocksOnASingleLine: Never
AllowShortCaseLabelsOnASingleLine: false
AllowShortFunctionsOnASingleLine: None
AllowShortIfStatementsOnASingleLine: false
AllowShortLoopsOnASingleLine: false
AlwaysBreakAfterDefinitionReturnType: None
AlwaysBreakAfterReturnType: None
AlwaysBreakTemplateDeclarations: Yes
BinPackArguments: false
BinPackParameters: false
BraceWrapping:
AfterCaseLabel: false
AfterClass: false
AfterControlStatement: false
AfterEnum: false
AfterFunction: false
AfterNamespace: false
AfterStruct: false
AfterUnion: false
AfterExternBlock: false
BeforeCatch: false
BeforeElse: false
BeforeLambdaBody: false
BeforeWhile: false
SplitEmptyFunction: false
SplitEmptyRecord: false
SplitEmptyNamespace: false
AfterObjCDeclaration: false
IndentBraces: false
BreakBeforeBraces: Custom
BreakBeforeTernaryOperators: true
BreakConstructorInitializers: AfterColon
BreakConstructorInitializersBeforeComma: false
ColumnLimit: 120
CompactNamespaces: false
ConstructorInitializerAllOnOneLineOrOnePerLine: false
ContinuationIndentWidth: 4
EmptyLineAfterAccessModifier: Never
EmptyLineBeforeAccessModifier: LogicalBlock
IncludeBlocks: Preserve
IncludeCategories:
- Regex: '^<.*'
Priority: 1
- Regex: '^".*'
Priority: 2
- Regex: '.*'
Priority: 3
IncludeIsMainRegex: ([-_](test|unittest))?$'([-_](test|unittest))?$'
IndentCaseBlocks: false
IndentCaseLabels: true
IndentGotoLabels: true
IndentPPDirectives: None
IndentWidth: 2
IndentWrappedFunctionNames: false
InsertNewlineAtEOF: true
MacroBlockBegin: ''
MacroBlockEnd: ''
MaxEmptyLinesToKeep: 1
NamespaceIndentation: None
PointerAlignment: Left
SpaceAfterCStyleCast: true
SpaceAfterLogicalNot: false
SpaceAfterTemplateKeyword: false
SpaceBeforeAssignmentOperators: true
SpaceBeforeInheritanceColon: true
SpaceBeforeParens: ControlStatements
SpaceBeforeRangeBasedForLoopColon: true
SpaceBeforeSquareBrackets: false
SpaceInEmptyParentheses: false
SpacesBeforeTrailingComments: 1
SpacesInAngles: false
SpacesInConditionalStatement: false
SpacesInCStyleCastParentheses: false
SpacesInParentheses: false
SpacesInSquareBrackets: false
TabWidth: 4
UseTab: Never
...
20 changes: 20 additions & 0 deletions .clang-tidy
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
Checks: '-*,
modernize-*,
performance-*,
cppcoreguidelines-*,
bugprone-*,
-modernize-use-trailing-return-type,
-performance-no-int-to-ptr,
-cppcoreguidelines-avoid-const-or-ref-data-members,
-cppcoreguidelines-pro-type-reinterpret-cast,
-cppcoreguidelines-pro-type-union-access,
-cppcoreguidelines-pro-bounds-pointer-arithmetic,
-bugprone-exception-escape,
-bugprone-easily-swappable-parameters'

WarningsAsErrors: ''
HeaderFilterRegex: ''
FormatStyle: none
CheckOptions:
- key: modernize-use-using.IgnoreMacros
value: 'true'
24 changes: 12 additions & 12 deletions .github/workflows/ci_tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,23 +18,23 @@ jobs:
- name: Build main target
shell: bash
run: |
cmake --build cmake-build-release --target cpp_tests || echo Built with errors
cmake --build cmake-build-release || echo Built with errors

- name: Build tests target
shell: bash
run: |
cmake --build cmake-build-debug --target cpp_tests_tests || echo Built with errors
cmake --build cmake-build-debug --target ovum_tests || echo Built with errors

- name: Run program
working-directory: .\cmake-build-release
run: |
.\cpp_tests.exe --help
.\ovum.exe --help

- name: Run tests
working-directory: .\cmake-build-debug
run: |
echo "Currently unable to run tests on Windows Latest MinGW. See https://gitmemories.com/cristianadam/HelloWorld/issues/12 and https://github.com/microsoft/vscode-cmake-tools/issues/2451"
% .\cpp_tests_tests.exe
% .\ovum_tests.exe

build-matrix:
name: Tests and application run on ${{ matrix.config.name }}
Expand Down Expand Up @@ -72,33 +72,33 @@ jobs:
- name: Build main target
shell: bash
run: |
cmake --build cmake-build-release --target cpp_tests || echo "Built with errors"
cmake --build cmake-build-release --target ovum || echo "Built with errors"

- name: Build tests target
shell: bash
run: |
cmake --build cmake-build-debug --target cpp_tests_tests || echo "Built with errors"
cmake --build cmake-build-debug --target ovum_tests || echo "Built with errors"

- name: Run program
shell: bash
working-directory: ./cmake-build-release
run: |
if [ "$RUNNER_OS" == "Windows" ]; then
./cpp_tests.exe --help
./ovum.exe --help
else
cd bin
./cpp_tests --help
./ovum --help
fi

- name: Run tests
shell: bash
working-directory: ./cmake-build-debug
run: |
if [ "$RUNNER_OS" == "Windows" ]; then
./cpp_tests_tests.exe
./ovum_tests.exe
else
cd tests
./cpp_tests_tests
./ovum_tests
fi

memory-leaks:
Expand All @@ -117,9 +117,9 @@ jobs:

- name: Build tests target
run: |
cmake --build cmake-build --target cpp_tests_tests
cmake --build cmake-build --target ovum_tests

- name: Run valgrind
working-directory: ./cmake-build/tests
run: |
valgrind --leak-check=full --track-origins=yes --error-exitcode=1 ./cpp_tests_tests
valgrind --leak-check=full --track-origins=yes --error-exitcode=1 ./ovum_tests
22 changes: 22 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# CMake
**cmake-build*/
build/

# All idea files
**.idea*/
Expand All @@ -10,6 +11,15 @@
# IntelliJ
**out/

# Visual Studio Code
**.vscode/
**.history/

# Clangd
compile_commands.json
compile_flags.txt
.clangd

# mpeltonen/sbt-idea plugin
**.idea_modules/

Expand All @@ -22,6 +32,18 @@ crashlytics.properties
crashlytics-build.properties
fabric.properties

# Notepad++ temporary file
*.bak

# API keys
*.apikey

# Cache directories
**cache*/

# Program settings files
**.config*/compiler/*

# Prerequisites
*.d

Expand Down
28 changes: 6 additions & 22 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,30 +1,14 @@
cmake_minimum_required(VERSION 3.12)

project(
cpp_tests # Rename the project here and in ci_tests.yml
VERSION 0.1
DESCRIPTION "C++ Project with Google tests"
LANGUAGES CXX
ovum
VERSION 0.1
DESCRIPTION "Ovum programming language toolset"
LANGUAGES CXX
)

set(CMAKE_CXX_STANDARD 20)

if (WIN32) # Install dlls in the same directory as the executable on Windows
set(CMAKE_LIBRARY_OUTPUT_DIRECTORY_DEBUG ${CMAKE_BINARY_DIR})
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY_DEBUG ${CMAKE_BINARY_DIR})
set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY_DEBUG ${CMAKE_BINARY_DIR})
set(CMAKE_LIBRARY_OUTPUT_DIRECTORY_RELEASE ${CMAKE_BINARY_DIR})
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY_RELEASE ${CMAKE_BINARY_DIR})
set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY_RELEASE ${CMAKE_BINARY_DIR})
endif ()

if (CMAKE_CXX_COMPILER_ID STREQUAL "MSVC")
set(CMAKE_CXX_FLAGS_DEBUG "/MDd")
set(CMAKE_CXX_FLAGS_RELEASE "/O2")
else ()
set(CMAKE_CXX_FLAGS_DEBUG "-g")
set(CMAKE_CXX_FLAGS_RELEASE "-O3")
endif ()
include(cmake/SetCompilerOptions.cmake)
include(cmake/IncludeExternalLibraries.cmake)

add_subdirectory(lib)
add_subdirectory(bin)
Expand Down
33 changes: 33 additions & 0 deletions CODEBASE_STRUCTURE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Базовая структура репозитория

## Назначение директорий

### Корневая директория
- **Документация проекта** - README, инструкции по сборке, руководства для разработчиков
- **Конфигурация сборки** - CMakeLists.txt, вспомогательные CMake-скрипты
- **Настройки инструментов** - конфигурации для форматирования, линтеров, Git
- **Скрипты автоматизации** - установка зависимостей, подготовка окружения

### bin/
- **Исполняемые файлы** - точка входа приложения
- **CLI-интерфейс** - командная строка для взаимодействия с пользователем

### docs/
- **Документация проекта** - README, инструкции по сборке, руководства для разработчиков

### lib/
- **Основная библиотека** - ядро функциональности проекта
- **UI-модуль** - пользовательский интерфейс и CLI-утилиты
- **Общие компоненты** - переиспользуемые части кода. Добавляйте новые модули только в эту директорию.

### tests/
- **Модульные тесты** - тестирование отдельных компонентов
- **Интеграционные тесты** - тестирование взаимодействия между модулями
- **Вспомогательные функции** - утилиты для тестирования
- **Тестовые данные** - примеры и фикстуры для тестов

### .github/workflows/
- **CI/CD конфигурация** - автоматическая сборка и тестирование
- **Проверки качества кода** - статический анализ, форматирование
- **Развертывание** - автоматическая публикация релизов

66 changes: 66 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
# Кодекс поведения участников Соглашения

## Наше обещание

В интересах создания открытой и доброжелательной среды мы, как участники и сопровождающие, обязуемся сделать участие в
нашем проекте и нашем сообществе свободным от преследований для всех, независимо от возраста, размера тела,
инвалидности, этнической принадлежности, половых характеристик, гендерной идентичности, самовыражение, уровня опыта,
образования, социально-экономического статус, национальности, внешнего вида, расы, религии или сексуальной идентичности
и ориентации.

## Наши стандарты

Примеры поведения, которое способствует созданию благоприятной среды, включают:

- Использование приветливого и инклюзивного языка
- Уважительное отношение к различным точкам зрения и опыту
- Изящно принимаю конструктивную критику
- Сосредоточение внимания на том, что лучше для сообщества
- Проявление сочувствия к другим членам сообщества

Примеры недопустимого поведения участников включают:

- Использование сексуализированной лексики или образов и нежелательное сексуальное внимание или заигрывания
- Троллинг, оскорбительные / уничижительные комментарии, а также личные или политические нападки
- Публичное или частное преследование
- Публикация частной информации других лиц, такой как физический или электронный адрес, без явного разрешения
- Другое поведение, которое можно обоснованно считать неуместным в профессиональной среде.

## Наши обязанности

Сопровождающие проекта несут ответственность за разъяснение стандартов приемлемого поведения и от них ожидают принятия
соответствующих и справедливых корректирующих действий в ответ на любые случаи неприемлемого поведения.

Сопровождающие проекта имеют право и обязаны удалять, редактировать или отклонять комментарии, коммиты, код, правки
вики, проблемы и другие материалы, которые не соответствуют настоящему Кодексу поведения, или временно или навсегда
заблокировать любого участника за другое поведение, которое они считают неуместным, угрожающим, оскорбительным или
вредным.

## Сфера

Этот Кодекс поведения применяется как в проектных, так и в общественных местах, когда человек представляет проект или
его сообщество. Примеры представления проекта или сообщества включают использование официального адреса электронной
почты проекта, размещение сообщений через официальную учетную запись в социальных сетях или выполнение функций
назначенного представителя на онлайн- или офлайн-мероприятии. Представление проекта может быть дополнительно определено
и уточнено сопровождающими проекта.

## Исполнение

О случаях оскорбления, преследования или иного недопустимого поведения можно сообщить, связавшись с командой проекта по
адресу [bigulov.sasha@gmail.com](mailto:bigulov.sasha@gmail.com). Все жалобы будут рассмотрены и исследованы, и в результате будет дан ответ, который будет
сочтен необходимым и соответствующим обстоятельствам. Команда проекта обязана сохранять конфиденциальность в отношении
лица, сообщившего об инциденте. Более подробная информация о конкретных правилах применения может быть опубликована
отдельно.

Сопровождающие проекта, которые не соблюдают и не соблюдают Кодекс поведения добросовестно, могут столкнуться с
временными или постоянными последствиями, как это определено другими членами руководства проекта.

## Атрибуция

Этот Кодекс поведения адаптирован из [Соглашения для авторов], версия 1.4, доступного по
адресу https://www.contributor-covenant.org/version/1/4/code-of-conduct.html.

Ответы на распространенные вопросы об этом кодексе поведения см. https://www.contributor-covenant.org/faq.


[Соглашения для авторов]: https://www.contributor-covenant.org
Loading
Loading