Initial commit

.gitignore

@@ -0,0 +1 @@
+build/

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "glfw"]
+	path = glfw
+	url = https://git.shylie.info/shylie/glfw.git

CMakeLists.txt

@@ -0,0 +1,55 @@
+cmake_minimum_required(VERSION 3.28)
+
+project(glerminal
+	VERSION 0.1.0
+	LANGUAGES C CXX
+)
+
+add_subdirectory(glfw)
+
+add_library(glerminal STATIC
+	include/glerminal.h
+
+	source/glerminal-private.h
+	source/glerminal.cpp
+
+	source/glad/glad.h
+	source/KHR/khrplatform.h
+	source/glad.c
+)
+
+set_target_properties(glerminal
+	PROPERTIES
+		CXX_STANDARD 11
+)
+
+target_include_directories(glerminal
+	PUBLIC
+		include
+	PRIVATE
+		source
+)
+
+target_link_libraries(glerminal
+	PUBLIC
+		glfw
+)
+
+target_compile_definitions(glerminal
+	PUBLIC
+		GLERMINAL_VERSION=${PROJECT_VERSION}
+		GLERMINAL_VERSION_MAJOR=${PROJECT_VERSION_MAJOR}
+		GLERMINAL_VERSION_MINOR=${PROJECT_VERSION_MINOR}
+		GLERMINAL_VERSION_PATCH=${PROJECT_VERSION_PATCH}
+)
+
+if (MSVC)
+	target_link_options(glerminal
+		PUBLIC
+			"/ENTRY:mainCRTStartup"
+	)
+endif()
+
+if (PROJECT_IS_TOP_LEVEL)
+	add_subdirectory(examples examples)
+endif()

LICENSE

@@ -0,0 +1,19 @@
+zlib License
+
+(C) 2024 Shylie
+
+This software is provided 'as-is', without any express or implied
+warranty.  In no event will the authors be held liable for any damages
+arising from the use of this software.
+
+Permission is granted to anyone to use this software for any purpose,
+including commercial applications, and to alter it and redistribute it
+freely, subject to the following restrictions:
+
+1. The origin of this software must not be misrepresented; you must not
+   claim that you wrote the original software. If you use this software
+   in a product, an acknowledgment in the product documentation would be
+   appreciated but is not required.
+2. Altered source versions must be plainly marked as such, and must not be
+   misrepresented as being the original software.
+3. This notice may not be removed or altered from any source distribution.

README.md

@@ -0,0 +1,2 @@
+# termg
+

examples/CMakeLists.txt

@@ -0,0 +1,12 @@
+cmake_minimum_required(VERSION 3.28)
+
+set(CMAKE_FOLDER examples)
+
+add_executable(basic WIN32
+	basic.cpp
+)
+
+target_link_libraries(basic
+	PRIVATE
+		glerminal
+)

examples/basic.cpp

@@ -0,0 +1,6 @@
+#include <glerminal.h>
+
+int main(int argc, char** argv)
+{
+	glerminal_run(glerminal_flush);
+}

glfw

@@ -0,0 +1 @@
+Subproject commit b35641f4a3c62aa86a0b3c983d163bc0fe36026d

include/glerminal.h

@@ -0,0 +1,19 @@
+#ifndef GLERMINAL_H
+#define GLERMINAL_H
+
+#ifdef __cplusplus
+extern "C"
+{
+#endif
+
+typedef void (*glerminal_main_cb)();
+
+void glerminal_run(glerminal_main_cb main);
+
+void glerminal_flush();
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif//GLERMINAL_H

source/KHR/khrplatform.h

@@ -0,0 +1,311 @@
+#ifndef __khrplatform_h_
+#define __khrplatform_h_
+
+/*
+** Copyright (c) 2008-2018 The Khronos Group Inc.
+**
+** Permission is hereby granted, free of charge, to any person obtaining a
+** copy of this software and/or associated documentation files (the
+** "Materials"), to deal in the Materials without restriction, including
+** without limitation the rights to use, copy, modify, merge, publish,
+** distribute, sublicense, and/or sell copies of the Materials, and to
+** permit persons to whom the Materials are 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 Materials.
+**
+** THE MATERIALS ARE 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
+** MATERIALS OR THE USE OR OTHER DEALINGS IN THE MATERIALS.
+*/
+
+/* Khronos platform-specific types and definitions.
+ *
+ * The master copy of khrplatform.h is maintained in the Khronos EGL
+ * Registry repository at https://github.com/KhronosGroup/EGL-Registry
+ * The last semantic modification to khrplatform.h was at commit ID:
+ *      67a3e0864c2d75ea5287b9f3d2eb74a745936692
+ *
+ * Adopters may modify this file to suit their platform. Adopters are
+ * encouraged to submit platform specific modifications to the Khronos
+ * group so that they can be included in future versions of this file.
+ * Please submit changes by filing pull requests or issues on
+ * the EGL Registry repository linked above.
+ *
+ *
+ * See the Implementer's Guidelines for information about where this file
+ * should be located on your system and for more details of its use:
+ *    http://www.khronos.org/registry/implementers_guide.pdf
+ *
+ * This file should be included as
+ *        #include <KHR/khrplatform.h>
+ * by Khronos client API header files that use its types and defines.
+ *
+ * The types in khrplatform.h should only be used to define API-specific types.
+ *
+ * Types defined in khrplatform.h:
+ *    khronos_int8_t              signed   8  bit
+ *    khronos_uint8_t             unsigned 8  bit
+ *    khronos_int16_t             signed   16 bit
+ *    khronos_uint16_t            unsigned 16 bit
+ *    khronos_int32_t             signed   32 bit
+ *    khronos_uint32_t            unsigned 32 bit
+ *    khronos_int64_t             signed   64 bit
+ *    khronos_uint64_t            unsigned 64 bit
+ *    khronos_intptr_t            signed   same number of bits as a pointer
+ *    khronos_uintptr_t           unsigned same number of bits as a pointer
+ *    khronos_ssize_t             signed   size
+ *    khronos_usize_t             unsigned size
+ *    khronos_float_t             signed   32 bit floating point
+ *    khronos_time_ns_t           unsigned 64 bit time in nanoseconds
+ *    khronos_utime_nanoseconds_t unsigned time interval or absolute time in
+ *                                         nanoseconds
+ *    khronos_stime_nanoseconds_t signed time interval in nanoseconds
+ *    khronos_boolean_enum_t      enumerated boolean type. This should
+ *      only be used as a base type when a client API's boolean type is
+ *      an enum. Client APIs which use an integer or other type for
+ *      booleans cannot use this as the base type for their boolean.
+ *
+ * Tokens defined in khrplatform.h:
+ *
+ *    KHRONOS_FALSE, KHRONOS_TRUE Enumerated boolean false/true values.
+ *
+ *    KHRONOS_SUPPORT_INT64 is 1 if 64 bit integers are supported; otherwise 0.
+ *    KHRONOS_SUPPORT_FLOAT is 1 if floats are supported; otherwise 0.
+ *
+ * Calling convention macros defined in this file:
+ *    KHRONOS_APICALL
+ *    KHRONOS_APIENTRY
+ *    KHRONOS_APIATTRIBUTES
+ *
+ * These may be used in function prototypes as:
+ *
+ *      KHRONOS_APICALL void KHRONOS_APIENTRY funcname(
+ *                                  int arg1,
+ *                                  int arg2) KHRONOS_APIATTRIBUTES;
+ */
+
+#if defined(__SCITECH_SNAP__) && !defined(KHRONOS_STATIC)
+#   define KHRONOS_STATIC 1
+#endif
+
+/*-------------------------------------------------------------------------
+ * Definition of KHRONOS_APICALL
+ *-------------------------------------------------------------------------
+ * This precedes the return type of the function in the function prototype.
+ */
+#if defined(KHRONOS_STATIC)
+    /* If the preprocessor constant KHRONOS_STATIC is defined, make the
+     * header compatible with static linking. */
+#   define KHRONOS_APICALL
+#elif defined(_WIN32)
+#   define KHRONOS_APICALL __declspec(dllimport)
+#elif defined (__SYMBIAN32__)
+#   define KHRONOS_APICALL IMPORT_C
+#elif defined(__ANDROID__)
+#   define KHRONOS_APICALL __attribute__((visibility("default")))
+#else
+#   define KHRONOS_APICALL
+#endif
+
+/*-------------------------------------------------------------------------
+ * Definition of KHRONOS_APIENTRY
+ *-------------------------------------------------------------------------
+ * This follows the return type of the function  and precedes the function
+ * name in the function prototype.
+ */
+#if defined(_WIN32) && !defined(_WIN32_WCE) && !defined(__SCITECH_SNAP__)
+    /* Win32 but not WinCE */
+#   define KHRONOS_APIENTRY __stdcall
+#else
+#   define KHRONOS_APIENTRY
+#endif
+
+/*-------------------------------------------------------------------------
+ * Definition of KHRONOS_APIATTRIBUTES
+ *-------------------------------------------------------------------------
+ * This follows the closing parenthesis of the function prototype arguments.
+ */
+#if defined (__ARMCC_2__)
+#define KHRONOS_APIATTRIBUTES __softfp
+#else
+#define KHRONOS_APIATTRIBUTES
+#endif
+
+/*-------------------------------------------------------------------------
+ * basic type definitions
+ *-----------------------------------------------------------------------*/
+#if (defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L) || defined(__GNUC__) || defined(__SCO__) || defined(__USLC__)
+
+
+/*
+ * Using <stdint.h>
+ */
+#include <stdint.h>
+typedef int32_t                 khronos_int32_t;
+typedef uint32_t                khronos_uint32_t;
+typedef int64_t                 khronos_int64_t;
+typedef uint64_t                khronos_uint64_t;
+#define KHRONOS_SUPPORT_INT64   1
+#define KHRONOS_SUPPORT_FLOAT   1
+/*
+ * To support platform where unsigned long cannot be used interchangeably with
+ * inptr_t (e.g. CHERI-extended ISAs), we can use the stdint.h intptr_t.
+ * Ideally, we could just use (u)intptr_t everywhere, but this could result in
+ * ABI breakage if khronos_uintptr_t is changed from unsigned long to
+ * unsigned long long or similar (this results in different C++ name mangling).
+ * To avoid changes for existing platforms, we restrict usage of intptr_t to
+ * platforms where the size of a pointer is larger than the size of long.
+ */
+#if defined(__SIZEOF_LONG__) && defined(__SIZEOF_POINTER__)
+#if __SIZEOF_POINTER__ > __SIZEOF_LONG__
+#define KHRONOS_USE_INTPTR_T
+#endif
+#endif
+
+#elif defined(__VMS ) || defined(__sgi)
+
+/*
+ * Using <inttypes.h>
+ */
+#include <inttypes.h>
+typedef int32_t                 khronos_int32_t;
+typedef uint32_t                khronos_uint32_t;
+typedef int64_t                 khronos_int64_t;
+typedef uint64_t                khronos_uint64_t;
+#define KHRONOS_SUPPORT_INT64   1
+#define KHRONOS_SUPPORT_FLOAT   1
+
+#elif defined(_WIN32) && !defined(__SCITECH_SNAP__)
+
+/*
+ * Win32
+ */
+typedef __int32                 khronos_int32_t;
+typedef unsigned __int32        khronos_uint32_t;
+typedef __int64                 khronos_int64_t;
+typedef unsigned __int64        khronos_uint64_t;
+#define KHRONOS_SUPPORT_INT64   1
+#define KHRONOS_SUPPORT_FLOAT   1
+
+#elif defined(__sun__) || defined(__digital__)
+
+/*
+ * Sun or Digital
+ */
+typedef int                     khronos_int32_t;
+typedef unsigned int            khronos_uint32_t;
+#if defined(__arch64__) || defined(_LP64)
+typedef long int                khronos_int64_t;
+typedef unsigned long int       khronos_uint64_t;
+#else
+typedef long long int           khronos_int64_t;
+typedef unsigned long long int  khronos_uint64_t;
+#endif /* __arch64__ */
+#define KHRONOS_SUPPORT_INT64   1
+#define KHRONOS_SUPPORT_FLOAT   1
+
+#elif 0
+
+/*
+ * Hypothetical platform with no float or int64 support
+ */
+typedef int                     khronos_int32_t;
+typedef unsigned int            khronos_uint32_t;
+#define KHRONOS_SUPPORT_INT64   0
+#define KHRONOS_SUPPORT_FLOAT   0
+
+#else
+
+/*
+ * Generic fallback
+ */
+#include <stdint.h>
+typedef int32_t                 khronos_int32_t;
+typedef uint32_t                khronos_uint32_t;
+typedef int64_t                 khronos_int64_t;
+typedef uint64_t                khronos_uint64_t;
+#define KHRONOS_SUPPORT_INT64   1
+#define KHRONOS_SUPPORT_FLOAT   1
+
+#endif
+
+
+/*
+ * Types that are (so far) the same on all platforms
+ */
+typedef signed   char          khronos_int8_t;
+typedef unsigned char          khronos_uint8_t;
+typedef signed   short int     khronos_int16_t;
+typedef unsigned short int     khronos_uint16_t;
+
+/*
+ * Types that differ between LLP64 and LP64 architectures - in LLP64,
+ * pointers are 64 bits, but 'long' is still 32 bits. Win64 appears
+ * to be the only LLP64 architecture in current use.
+ */
+#ifdef KHRONOS_USE_INTPTR_T
+typedef intptr_t               khronos_intptr_t;
+typedef uintptr_t              khronos_uintptr_t;
+#elif defined(_WIN64)
+typedef signed   long long int khronos_intptr_t;
+typedef unsigned long long int khronos_uintptr_t;
+#else
+typedef signed   long  int     khronos_intptr_t;
+typedef unsigned long  int     khronos_uintptr_t;
+#endif
+
+#if defined(_WIN64)
+typedef signed   long long int khronos_ssize_t;
+typedef unsigned long long int khronos_usize_t;
+#else
+typedef signed   long  int     khronos_ssize_t;
+typedef unsigned long  int     khronos_usize_t;
+#endif
+
+#if KHRONOS_SUPPORT_FLOAT
+/*
+ * Float type
+ */
+typedef          float         khronos_float_t;
+#endif
+
+#if KHRONOS_SUPPORT_INT64
+/* Time types
+ *
+ * These types can be used to represent a time interval in nanoseconds or
+ * an absolute Unadjusted System Time.  Unadjusted System Time is the number
+ * of nanoseconds since some arbitrary system event (e.g. since the last
+ * time the system booted).  The Unadjusted System Time is an unsigned
+ * 64 bit value that wraps back to 0 every 584 years.  Time intervals
+ * may be either signed or unsigned.
+ */
+typedef khronos_uint64_t       khronos_utime_nanoseconds_t;
+typedef khronos_int64_t        khronos_stime_nanoseconds_t;
+#endif
+
+/*
+ * Dummy value used to pad enum types to 32 bits.
+ */
+#ifndef KHRONOS_MAX_ENUM
+#define KHRONOS_MAX_ENUM 0x7FFFFFFF
+#endif
+
+/*
+ * Enumerated boolean type
+ *
+ * Values other than zero should be considered to be true.  Therefore
+ * comparisons should not be made against KHRONOS_TRUE.
+ */
+typedef enum {
+    KHRONOS_FALSE = 0,
+    KHRONOS_TRUE  = 1,
+    KHRONOS_BOOLEAN_ENUM_FORCE_SIZE = KHRONOS_MAX_ENUM
+} khronos_boolean_enum_t;
+
+#endif /* __khrplatform_h_ */

source/glerminal-private.h

@@ -0,0 +1,46 @@
+#ifndef TERMG_PRIVATE_H
+#define TERMG_PRIVATE_H
+
+#include "glerminal.h"
+
+#include <glad/glad.h>
+#include <GLFW/glfw3.h>
+
+#include <stdexcept>
+
+namespace glerminal
+{
+	class glerminal
+	{
+	public:
+		glerminal(glerminal_main_cb main);
+		~glerminal();
+
+		glerminal(const glerminal&) = delete;
+		glerminal(glerminal&&) = delete;
+
+		glerminal& operator=(const glerminal&) = delete;
+		glerminal& operator=(glerminal&&) = delete;
+
+		void run();
+
+		void flush();
+
+	private:
+		GLFWwindow* m_window;
+
+		unsigned int m_vbo;
+		unsigned int m_vao;
+		unsigned int m_program;
+
+		glerminal_main_cb m_main;
+
+		void init_glfw();
+		void init_gl();
+
+		void deinit_glfw();
+		void deinit_gl();
+	};
+}
+
+#endif//TERMG_PRIVATE_H

source/glerminal.cpp

@@ -0,0 +1,231 @@
+#include "glerminal-private.h"
+
+#include <iostream>
+
+namespace
+{
+	glerminal::glerminal* GLERMINAL_G = nullptr;
+
+	constexpr float VBO_VERTICES[] =
+	{
+		// first triangle
+		 0.5f,  0.5f, // top right
+		 0.5f, -0.5f, // bottom right
+		-0.5f,  0.5f, // top left
+
+		// second triangle
+		 0.5f, -0.5f, // bottom right
+		-0.5f, -0.5f, // bottom left
+		-0.5f,  0.5f  // top left
+	};
+
+	constexpr char* VERTEX_SHADER_SOURCE =
+		"#version 330 core\n"
+		"layout (location = 0) in vec2 pos;\n"
+		"void main()\n"
+		"{\n"
+		"	gl_Position = vec4(pos.x, pos.y, 0, 1);\n"
+		"}";
+
+	constexpr char* FRAGMENT_SHADER_SOURCE =
+		"#version 330 core\n"
+		"out vec4 FragColor;\n"
+		"\n"
+		"void main()\n"
+		"{\n"
+		"	FragColor = vec4(1.0f, 0.5f, 0.2f, 1.0f);\n"
+		"}";
+}
+
+namespace glerminal
+{
+	glerminal::glerminal(glerminal_main_cb main) :
+		m_main(main)
+	{
+		if (GLERMINAL_G)
+		{
+			throw std::runtime_error("glerminal is already running.");
+		}
+
+		// unsure if this should be an error
+		if (!m_main)
+		{
+			throw std::runtime_error("No main callback provided.");
+		}
+
+		init_glfw();
+		init_gl();
+
+		GLERMINAL_G = this;
+	}
+
+	glerminal::~glerminal()
+	{
+		deinit_gl();
+		deinit_glfw();
+
+		GLERMINAL_G = nullptr;
+	}
+
+	void glerminal::run()
+	{
+		while (!glfwWindowShouldClose(m_window))
+		{
+			glfwPollEvents();
+
+			m_main();
+		}
+	}
+
+	void glerminal::flush()
+	{
+		glClear(GL_COLOR_BUFFER_BIT);
+
+		glUseProgram(m_program);
+		glBindVertexArray(m_vao);
+		glDrawArrays(GL_TRIANGLES, 0, 6);
+
+		glfwSwapBuffers(m_window);
+	}
+
+	void glerminal::init_glfw()
+	{
+		glfwInit();
+
+		glfwWindowHint(GLFW_CONTEXT_VERSION_MAJOR, 3);
+		glfwWindowHint(GLFW_CONTEXT_VERSION_MINOR, 3);
+		glfwWindowHint(GLFW_OPENGL_PROFILE, GLFW_OPENGL_CORE_PROFILE);
+		// not resizable for now.
+		// 
+		// need to think about how to handle resizing to ensure
+		// that the window stays an integer number of "tiles" large
+		glfwWindowHint(GLFW_RESIZABLE, GLFW_FALSE);
+
+		// non-adjustable size for the same reason as above
+		m_window = glfwCreateWindow(1280, 800, "glerminal", nullptr, nullptr);
+
+		if (!m_window)
+		{
+			throw std::runtime_error("Failed to create glerminal window.");
+		}
+	}
+
+	void glerminal::init_gl()
+	{
+		glfwMakeContextCurrent(m_window);
+		glfwSwapInterval(1);
+
+		if (!gladLoadGLLoader(reinterpret_cast<GLADloadproc>(glfwGetProcAddress)))
+		{
+			throw std::runtime_error("Failed to initialize GLAD.");
+		}
+
+		glViewport(0, 0, 1280, 800);
+		glPolygonMode(GL_FRONT_AND_BACK, GL_LINE);
+
+		// -- setup vertex data --
+		// create vertex buffer object
+		glGenBuffers(1, &m_vbo);
+
+		// create vertex array object
+		glGenVertexArrays(1, &m_vao);
+		glBindVertexArray(m_vao);
+
+		// bind buffer and copy data
+		glBindBuffer(GL_ARRAY_BUFFER, m_vbo);
+		glBufferData(GL_ARRAY_BUFFER, sizeof(VBO_VERTICES), VBO_VERTICES, GL_STATIC_DRAW);
+
+		// set up vertex attributes
+		glVertexAttribPointer(0, 2, GL_FLOAT, GL_FALSE, 2 * sizeof(float), reinterpret_cast<void*>(0));
+		glEnableVertexAttribArray(0);
+
+
+		// -- setup shader program --
+		// compile
+		const unsigned int vertex_shader = glCreateShader(GL_VERTEX_SHADER);
+		glShaderSource(vertex_shader, 1, &VERTEX_SHADER_SOURCE, nullptr);
+		glCompileShader(vertex_shader);
+
+		const unsigned int fragment_shader = glCreateShader(GL_FRAGMENT_SHADER);
+		glShaderSource(fragment_shader, 1, &FRAGMENT_SHADER_SOURCE, nullptr);
+		glCompileShader(fragment_shader);
+
+		int success;
+		char info_log[512] = {};
+
+		// verify
+		glGetShaderiv(vertex_shader, GL_COMPILE_STATUS, &success);
+		if (!success)
+		{
+			glGetShaderInfoLog(vertex_shader, sizeof(info_log) / sizeof(*info_log), nullptr, info_log);
+			glDeleteShader(vertex_shader);
+			glDeleteShader(fragment_shader);
+
+			using namespace std::string_literals;
+			throw std::runtime_error("Could not compile vertex shader: "s + info_log);
+		}
+
+		glGetShaderiv(fragment_shader, GL_COMPILE_STATUS, &success);
+		if (!success)
+		{
+			glGetShaderInfoLog(fragment_shader, sizeof(info_log) / sizeof(*info_log), nullptr, info_log);
+			glDeleteShader(vertex_shader);
+			glDeleteShader(fragment_shader);
+
+			using namespace std::string_literals;
+			throw std::runtime_error("Could not compile fragment shader: "s + info_log);
+		}
+
+		// link
+		m_program = glCreateProgram();
+		glAttachShader(m_program, vertex_shader);
+		glAttachShader(m_program, fragment_shader);
+		glLinkProgram(m_program);
+		glDeleteShader(vertex_shader);
+		glDeleteShader(fragment_shader);
+
+		// verify again
+		glGetProgramiv(m_program, GL_LINK_STATUS, &success);
+		if (!success)
+		{
+			glGetProgramInfoLog(m_program, sizeof(info_log) / sizeof(*info_log), nullptr, info_log);
+			glDeleteProgram(m_program);
+
+			using namespace std::string_literals;
+			throw std::runtime_error("Could not link shader program: "s + info_log);
+		}
+	}
+
+	void glerminal::deinit_glfw()
+	{
+		glDeleteProgram(m_program);
+
+		glfwDestroyWindow(m_window);
+
+		glfwTerminate();
+	}
+
+	void glerminal::deinit_gl()
+	{
+		glDeleteProgram(m_program);
+	}
+}
+
+void glerminal_run(glerminal_main_cb main)
+{
+	try
+	{
+		glerminal::glerminal(main).run();
+	}
+	catch (const std::runtime_error& e)
+	{
+		std::cout << "[glerminal] " << e.what() << std::endl;
+	}
+}
+
+void glerminal_flush()
+{
+	if (!GLERMINAL_G) { return; }
+
+	GLERMINAL_G->flush();
+}