khetai 0.1.7 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 57b893b2ca7a9ab8690ce116801bbd6286bc5856c7f87d01b7d51a7bbd6cc8f9
-  data.tar.gz: 433c4c67445b585526e598f6c04c53ca9e3ce67dab012a65aafa9922d18d8a80
+  metadata.gz: a32fa87a05f48b757c7e3c601e26313ad9d58d7c2ff773603d89ec8313c7d07b
+  data.tar.gz: 47f0883f7445baaf8541b340caff8e929d01ef1fa8c175b859936ecad30c355e
 SHA512:
-  metadata.gz: 5e85bedabf5229ac1abad59889e2d2980e0fe194ad42d3acff67fb72817ed6755b59798af3a7312836cc225bb044f1bc12641edb30f4693e37e91144581ac142
-  data.tar.gz: f7cb8d7735f580752ed50ca8f4cf084a5398bbac70d26b32da6c9a61049de9a79b68aceac685afe5a907ec8bea83ba24e72fcf3c991a88145996c5a8563b85e3
+  metadata.gz: 9df12c681f8bfc73d712c5682d483038abc81793d48235af7038dcf75cefa12d84de2c8760f88c036365115a4074d40f877c2707aa8faa38e5b126bf43b10b22
+  data.tar.gz: d5663b3a6b7110b86c309530f4dc7cdb019afbaf1c8148a670366088a486bd2406fdc5c49f3c83bd586f2fba8a74cd6e4f5c08f1fb9329697b9b6c8e0bad29f1

data/.gitignore

@@ -7,5 +7,10 @@
 /spec/reports/
 /tmp/
 /build/
+/ext/khetai/dev/build/
+/ext/khetai/dev/fltk-ui/build/
+/ext/khetai/dev/fltk-ui/build_khetai/
 .vscode
 *.so
+*.o
+khet

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    khetai (0.1.7)
+    khetai (0.2.0)
 
 GEM
   remote: https://rubygems.org/
@@ -19,4 +19,4 @@ DEPENDENCIES
   rake-compiler
 
 BUNDLED WITH
-   2.1.2
+   2.4.21

data/README.md

@@ -1,34 +1,31 @@
 # KhetAI
 
-## Install
-```
-gem install khetai
-```
+## Installation
+
+    $ gem install khetai
 
 ## Usage
-```
+```ruby
 require 'khetai'
 move = KhetAI.move(board, whose_turn, max_search_depth, max_search_time)
 ```
 
 ## Example
-```
+```ruby
 require 'khetai'
 
 # initial board setup:
 # A = anubis, P = pyramid, S = scarab, X = pharaoh, L = sphinx
 # capital letters = red, lowercase letters = silver
 # 0 = north, 1 = east, 2 = south, 3 = west
-board = ["--", "--", "--", "--", "--", "--", "--", "--", "--", "--", "--", "--",
-        "--", "L2", "--", "--", "--", "A2", "X2", "A2", "P1", "--", "--", "--",
-        "--", "--", "--", "P2", "--", "--", "--", "--", "--", "--", "--", "--",
-        "--", "--", "--", "--", "p3", "--", "--", "--", "--", "--", "--", "--",
-        "--", "P0", "--", "p2", "--", "S2", "S3", "--", "P1", "--", "p3", "--",
-        "--", "P1", "--", "p3", "--", "s1", "s0", "--", "P0", "--", "p2", "--",
-        "--", "--", "--", "--", "--", "--", "--", "P1", "--", "--", "--", "--",
-        "--", "--", "--", "--", "--", "--", "--", "--", "p0", "--", "--", "--",
-        "--", "--", "--", "p3", "a0", "x0", "a0", "--", "--", "--", "l0", "--",
-        "--", "--", "--", "--", "--", "--", "--", "--", "--", "--", "--", "--"]
+board = ["L2", "--", "--", "--", "A2", "X2", "A2", "P1", "--", "--",
+         "--", "--", "P2", "--", "--", "--", "--", "--", "--", "--",
+         "--", "--", "--", "p3", "--", "--", "--", "--", "--", "--",
+         "P0", "--", "p2", "--", "S2", "S3", "--", "P1", "--", "p3",
+         "P1", "--", "p3", "--", "s1", "s0", "--", "P0", "--", "p2",
+         "--", "--", "--", "--", "--", "--", "P1", "--", "--", "--",
+         "--", "--", "--", "--", "--", "--", "--", "p0", "--", "--",
+         "--", "--", "p3", "a0", "x0", "a0", "--", "--", "--", "l0"]
 
 whose_turn = 1          # silver = 0, red = 1
 max_search_depth = 25   # must be between 2 and 25
@@ -42,11 +39,28 @@ move = KhetAI.move(board, whose_turn, max_search_depth, max_search_time)
 # move[2] = rotation (1, -1, 0) (clockwise, anticlockwise, none)
 ```
 
+The representation of the board gets converted an array of 8-bit integers once it is passed to the gem.
+
+## Development
+
+The internals of the gem are written in C, located in `ext/khetai`.
+
 ## Build and Deploy Commands
-```
-bundle exec rake compile
-bundle exec rake build
-bundle exec rake release
 
-gem push pkg/<gem>
-```
+    $ bundle exec rake compile
+    $ bundle exec rake build
+    $ gem install pkg/khetai-<version>.gem
+
+
+To release and push to rubygems.org:
+
+    $ bundle exec rake release
+    $ gem push pkg/<gem>
+
+## Manual Testing
+
+There is a GUI test harness written in C++ using FLTK available in the `ext/khetai/dev/fltk-ui` directory.
+
+### Why does this exist?
+
+To learn, build, and have fun.

data/ext/khetai/dev/README.md

@@ -0,0 +1,15 @@
+# Dev Tools
+
+A few ways to test the khetai_lib...
+
+### main.c
+
+A small C program to execute a single move from the starting position.
+
+### main.rb
+
+A small Ruby program that will execute a single move form the starting position.
+
+### fltk-ui
+
+A C++ FLTK GUI that allows you set up the board however you want and request a move.

data/ext/khetai/dev/fltk-ui/Makefile

@@ -0,0 +1,65 @@
+# Makefile for both the C++ FLTK GUI and the KhetAI lib as a shared object
+
+# Compiler settings
+CXX = g++
+CC = gcc
+CXXFLAGS = -std=c++17 $(shell fltk-config --cxxflags) -fPIC -MMD -MP
+CFLAGS = -std=c11 -fPIC -MMD -MP
+LDFLAGS = $(shell fltk-config --ldflags) -lfltk_images -lfltk_png -lfltk_z -ldl
+
+# Application name
+APP = khet
+
+# Source directory
+SRC_DIR = .
+
+# Build directory
+BUILD_DIR = build
+
+# Source files
+SRC_CPP = $(wildcard $(SRC_DIR)/*.cpp)
+SRC_C = ../../khetai_lib.c
+
+# Object files
+OBJ_CPP = $(patsubst $(SRC_DIR)/%.cpp,$(BUILD_DIR)/%.o,$(SRC_CPP))
+OBJ_C = $(patsubst ../../%.c,$(BUILD_DIR)/%.o,$(SRC_C))
+
+# All object files
+OBJ = $(OBJ_CPP) $(OBJ_C)
+
+# AI Library
+AI_LIB = libkhetai.so
+
+# Default target
+all: $(BUILD_DIR) $(APP) $(AI_LIB)
+
+# Create the build directory
+$(BUILD_DIR):
+	mkdir -p $(BUILD_DIR)
+
+# Link the application
+$(APP): $(OBJ)
+	$(CXX) -o $@ $^ $(LDFLAGS)
+
+# Compile C++ source files into object files
+$(BUILD_DIR)/%.o: $(SRC_DIR)/%.cpp
+	$(CXX) -c $< -o $@ $(CXXFLAGS)
+
+# Compile C source files into object files
+$(BUILD_DIR)/%.o: ../../%.c
+	$(CC) -c $< -o $@ $(CFLAGS)
+
+# Compile AI library
+$(AI_LIB): $(OBJ_C)
+	$(CC) -shared -o $@ $^ $(CFLAGS)
+
+# Include generated dependency files
+-include $(OBJ_CPP:.o=.d)
+-include $(OBJ_C:.o=.d)
+
+# Clean target
+clean:
+	rm -f $(OBJ) $(APP) $(AI_LIB) $(BUILD_DIR)/*.d
+	rm -rf $(BUILD_DIR)
+
+.PHONY: all clean

data/ext/khetai/dev/fltk-ui/Makefile.khetai

@@ -0,0 +1,46 @@
+# Makefile for the KhetAI lib as a shared object
+# Used for hot reloading while the GUI is running
+
+# Compiler settings
+CC = gcc
+CFLAGS = -std=c11 -fPIC -O3 -MMD -MP
+
+# Source directory
+SRC_DIR = ../../
+
+# Build directory
+BUILD_DIR = build_khetai
+
+# Source files
+SRC = $(SRC_DIR)khetai_lib.c
+
+# Object files
+OBJ = $(BUILD_DIR)/khetai_lib.o
+
+# Library name
+LIB = libkhetai.so
+
+# Default target
+all: $(BUILD_DIR) $(LIB)
+
+# Create the build directory
+$(BUILD_DIR):
+	mkdir -p $(BUILD_DIR)
+
+# Compile the library
+$(LIB): $(OBJ)
+	$(CC) -shared -o $@ $^ $(CFLAGS)
+
+# Compile C source files into object files
+$(BUILD_DIR)/%.o: $(SRC_DIR)%.c
+	$(CC) -c $< -o $@ $(CFLAGS)
+
+# Include generated dependency files
+-include $(OBJ:.o=.d)
+
+# Clean target
+clean:
+	rm -f $(OBJ) $(LIB) $(BUILD_DIR)/*.d
+	rm -rf $(BUILD_DIR)
+
+.PHONY: all clean

data/ext/khetai/dev/fltk-ui/README.md

@@ -0,0 +1,34 @@
+# KhetAI Test Harness
+
+## Overview
+
+The KhetAI Test Harness provides a GUI for interacting with the KhetAI library. It is built in C++ using the Fast Light Toolkit (FLTK).
+
+### Hot Reload KhetAI Lib
+
+- While the GUI is running, you can edit the AI code and reload it into the app by pressing: `Shift + k`
+
+### Select and Move Piece
+
+- **Click** a square with a piece on it.
+- **Click** another square. If there is a piece on it, the two pieces will swap. Otherwise, the piece from the first square will just move to the newly selected square.
+
+### Rotate Piece
+
+- **Arrow Keys**: Rotate a piece after it has been clicked. Use the following keys to rotate the selected piece:
+  - `Left Arrow`: Rotate piece counter-clockwise
+  - `Right Arrow`: Rotate piece clockwise
+
+### Fire the Laser
+
+- `Space`: Fires the laser from whichever is selected. This is just used for visualization purposes.
+
+### Request AI Move
+
+- `Enter`: Uses `khetai_lib` to determine a move for Red. The pieces will move and the laser will fire automatically once it finishes.
+
+### Reset Pieces
+
+- Reset all pieces back to their original places by pressing: `r`
+
+![board](assets/example_board.png)

data/ext/khetai/dev/fltk-ui/ai_loader.cpp

@@ -0,0 +1,93 @@
+#include "ai_loader.h"
+
+AILoader::AILoader(const std::string &lib_path) : handle(nullptr)
+{
+    load_library(lib_path);
+}
+
+AILoader::~AILoader()
+{
+    if (handle)
+    {
+        dlclose(handle);
+    }
+}
+
+void AILoader::load_library(const std::string &lib_path)
+{
+    handle = dlopen(lib_path.c_str(), RTLD_LAZY);
+    if (!handle)
+    {
+        throw std::runtime_error("Failed to load KhetAI: " + std::string(dlerror()));
+    }
+}
+
+void AILoader::reload_library(const std::string &lib_path)
+{
+    if (handle)
+    {
+        dlclose(handle);
+    }
+    load_library(lib_path);
+}
+
+void *AILoader::get_symbol(const std::string &symbol_name)
+{
+    void *symbol = dlsym(handle, symbol_name.c_str());
+    check_error();
+    return symbol;
+}
+
+void AILoader::check_error()
+{
+    const char *error = dlerror();
+    if (error)
+    {
+        throw std::runtime_error("Error in dynamic loading: " + std::string(error));
+    }
+}
+
+void (*AILoader::get_init_zobrist())()
+{
+    return reinterpret_cast<void (*)()>(get_symbol("init_zobrist"));
+}
+
+void (*AILoader::get_setup_board())(char **)
+{
+    return reinterpret_cast<void (*)(char **)>(get_symbol("setup_board"));
+}
+
+void (*AILoader::get_print_board())()
+{
+    return reinterpret_cast<void (*)()>(get_symbol("print_board"));
+}
+
+void (*AILoader::get_set_time_parameters())(int, time_t)
+{
+    return reinterpret_cast<void (*)(int, time_t)>(get_symbol("set_time_parameters"));
+}
+
+Move (*AILoader::get_alphabeta_root())(int, enum Player)
+{
+    return reinterpret_cast<Move (*)(int, enum Player)>(get_symbol("alphabeta_root"));
+}
+
+void (*AILoader::get_make_move())(Move)
+{
+    return reinterpret_cast<void (*)(Move)>(get_symbol("make_move"));
+}
+
+int (*AILoader::get_get_start())(Move)
+{
+    return reinterpret_cast<int (*)(Move)>(get_symbol("get_start_wrapper"));
+}
+
+int (*AILoader::get_get_end())(Move)
+{
+    return reinterpret_cast<int (*)(Move)>(get_symbol("get_end_wrapper"));
+}
+
+int (*AILoader::get_get_rotation())(Move)
+{
+    return reinterpret_cast<int (*)(Move)>(get_symbol("get_rotation_wrapper"));
+}

data/ext/khetai/dev/fltk-ui/ai_loader.h

@@ -0,0 +1,33 @@
+#ifndef AI_LOADER_H
+#define AI_LOADER_H
+
+#include <dlfcn.h>
+#include <stdexcept>
+#include <string>
+#include "../../khetai_lib.h"
+
+class AILoader
+{
+public:
+    AILoader(const std::string &lib_path);
+    ~AILoader();
+
+    void (*get_init_zobrist())();
+    void (*get_setup_board())(char **);
+    void (*get_print_board())();
+    void (*get_set_time_parameters())(int, time_t);
+    Move (*get_alphabeta_root())(int, enum Player);
+    void (*get_make_move())(Move);
+    int (*get_get_start())(Move);
+    int (*get_get_end())(Move);
+    int (*get_get_rotation())(Move);
+    void reload_library(const std::string &lib_path);
+
+private:
+    void *handle;
+    void load_library(const std::string &lib_path);
+    void *get_symbol(const std::string &symbol_name);
+    void check_error();
+};
+
+#endif // AI_LOADER_H

data/ext/khetai/dev/fltk-ui/build_khetai.sh

@@ -0,0 +1,9 @@
+#!/bin/bash
+set -e
+
+cd "$(dirname "$0")"
+
+make -f Makefile.khetai clean
+make -f Makefile.khetai
+
+echo "KhetAI lib rebuilt successfully"