flamerobin: Instructions file for GitHub Copilot

FlameRobin — Copilot Instructions

FlameRobin is a C++20/wxWidgets GUI administration tool for Firebird DBMS.

Build

Linux (Debian/Ubuntu)

mkdir build && cd build
cmake ..
make -j$(nproc)
# Run from build dir (sets up paths to resource subdirs):
./run_flamerobin.sh

Windows (CMake + vcpkg)

cmake -S . -B build -A x64
cmake --build build --config Release

macOS

mkdir build && cd build
cmake -DCMAKE_PREFIX_PATH="$(brew --prefix)" ..
make -j$(nproc)
open flamerobin.app

vcpkg is used for dependencies and is auto-detected if cloned into the repo root as ./vcpkg. The fb-cpp dependency is supplied via a custom overlay port in ports/fb-cpp/.

When adding new .cpp files, re-run CMake to register them (cmake .. or cmake -S . -B build).

Tests

Run the full test suite from the build directory:

ctest --output-on-failure
# or with verbose Boost.Test output:
ctest --output-on-failure -V
BOOST_TEST_LOG_LEVEL=all ctest -R <test_name>

Run a single named test:

ctest -R index_ddl_test
# or run the executable directly:
./index_ddl_test

Test files are named *Test.cpp and are co-located with the source they test (e.g., src/metadata/IndexDDLTest.cpp). Tests use Boost.Test. Prefer comprehensive test cases that verify all related properties in one test rather than many small single-assertion tests.

Architecture

src/
├── engine/db/          # Database Abstraction Layer (DAL)
│   ├── IDatabase.h     # Core interfaces (IDatabase, ITransaction, IStatement, IService, IBlob)
│   ├── DatabaseBackend.h  # Shared types, enums (ColumnType, StatementType, BackupConfig, etc.)
│   ├── DatabaseFactory.{cpp,h}
│   ├── fbcpp/          # Modern fb-cpp backend (DEFAULT)
│   └── ibpp/           # Legacy IBPP backend (planned for removal)
├── metadata/           # Object model: Database, Table, View, Procedure, etc.
├── gui/                # wxWidgets frames and dialogs
├── core/               # Subject/Observer, template processing, utilities
├── sql/                # SQL tokenizer, statement splitter, keyword sets
├── ibpp/               # IBPP library source (legacy)
└── fb-cpp/             # fb-cpp submodule (keep clean — patches in ports/fb-cpp/)