Rewrite

.clang-format

@@ -116,7 +116,7 @@ BreakFunctionDefinitionParameters: false
 BreakInheritanceList: BeforeColon
 BreakStringLiterals: true
 BreakTemplateDeclarations: MultiLine
-ColumnLimit: 80
+ColumnLimit: 150
 CommentPragmas: "^ IWYU pragma:"
 CompactNamespaces: false
 ConstructorInitializerIndentWidth: 4

.github/workflows/doxygen.yml

@@ -0,0 +1,63 @@
+name: Deploy Doxygen page
+on:
+  push:
+    branches:
+      - pr/rewrite
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: 'recursive'
+
+      - name: Install Dependencies
+        run: |
+          sudo apt update
+          sudo apt install -y doxygen graphviz
+
+      - name: Set reusable strings
+        # Turn repeated input strings (such as the build output directory) into step outputs. These step outputs can be used throughout the workflow file.
+        id: strings
+        shell: bash
+        run: |
+          echo "build-output-dir=${{ github.workspace }}/doc" >> "$GITHUB_OUTPUT"
+
+      - name: Configure CMake
+        # Configure CMake in a 'build' subdirectory. CMAKE_BUILD_TYPE is only required if you are using a single-configuration generator such as make.
+        # See https://cmake.org/cmake/help/latest/variable/CMAKE_BUILD_TYPE.html?highlight=cmake_build_type
+        run: >
+          cmake -B ${{ steps.strings.outputs.build-output-dir }}
+          -S ${{ github.workspace }}
+          -DCMAKE_CXX_COMPILER=g++
+          -DCMAKE_C_COMPILER=gcc
+          -DCMAKE_BUILD_TYPE=Debug
+
+      - name: Generate docs
+        # Build your program with the given configuration. Note that --config is needed because the default Windows generator is a multi-config generator (Visual Studio generator).
+        run: >
+          cmake --build ${{ steps.strings.outputs.build-output-dir }} --config Debug --target JavaOutputStreams.Documentation
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ${{ steps.strings.outputs.build-output-dir }}/docs/html
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    needs: build
+    runs-on: ubuntu-latest
+    name: Deploy
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

CMakeLists.txt

@@ -1,5 +1,5 @@
 cmake_minimum_required(VERSION VERSION 3.30)
-project(JavaObjectStreams VERSION 1.0.2)
+project(JavaObjectStreams VERSION 1.2.0)
 
 set(CMAKE_CXX_STANDARD 20)
 
@@ -15,16 +15,105 @@ if (NOT TARGET bio)
 endif ()
 
 set(FILES
-        include/JavaObject/JavaSerializedClassParser.h
-        src/JavaSerializedClassParser.cpp
-        include/JavaObject/EJavaTypeCode.h
-        include/JavaObject/EJavaFieldDescriptorType.h
+        include/JavaObject/EObjectTypeCode.h
+        include/JavaObject/EPrimitiveTypeCode.h
         src/stream/ObjectOutputStream.cpp
         include/JavaObject/stream/ObjectOutputStream.h
         src/stream/ObjectInputStream.cpp
         include/JavaObject/stream/ObjectInputStream.h
         src/io/Serializable.cpp
         include/JavaObject/io/Serializable.h
+        src/type/object/parsers/ObjectParser.cpp
+        include/JavaObject/type/object/parsers/ObjectParser.h
+        src/type/object/types/IObject.cpp
+        include/JavaObject/type/object/parsers/IObjectParser.h
+        src/type/object/parsers/IObjectParser.cpp
+        include/JavaObject/type/object/types/IObject.h
+        include/JavaObject/type/object/types/NullObject.h
+        src/type/object/parsers/StringParser.cpp
+        include/JavaObject/type/object/parsers/StringParser.h
+        src/type/object/types/StringObject.cpp
+        include/JavaObject/type/object/types/StringObject.h
+        src/type/object/types/Object.cpp
+        include/JavaObject/type/object/types/Object.h
+        src/type/object/parsers/descriptor/NewClassDescriptorParser.cpp
+        include/JavaObject/type/object/parsers/descriptor/NewClassDescriptorParser.h
+        src/type/object/parsers/descriptor/ClassDescriptorInfoParser.cpp
+        include/JavaObject/type/object/parsers/descriptor/ClassDescriptorInfoParser.h
+        src/type/object/parsers/descriptor/FieldDescriptorParser.cpp
+        include/JavaObject/type/object/parsers/descriptor/FieldDescriptorParser.h
+        src/type/object/types/descriptor/PrimitiveDescriptorObject.cpp
+        include/JavaObject/type/object/types/descriptor/PrimitiveDescriptorObject.h
+        src/type/object/parsers/descriptor/PrimitiveDescriptorParser.cpp
+        include/JavaObject/type/object/parsers/descriptor/PrimitiveDescriptorParser.h
+        src/util/SmartPointerCast.cpp
+        include/JavaObject/util/SmartPointerCast.h
+        src/type/object/types/ClassDataObject.cpp
+        include/JavaObject/type/object/types/ClassDataObject.h
+        src/type/object/types/AnnotationObject.cpp
+        include/JavaObject/type/object/types/AnnotationObject.h
+        src/type/object/parsers/ClassDataParser.cpp
+        include/JavaObject/type/object/parsers/ClassDataParser.h
+        src/type/object/types/descriptor/ClassDescriptorObject.cpp
+        include/JavaObject/type/object/types/descriptor/ClassDescriptorObject.h
+        src/type/object/parsers/descriptor/ClassDescriptorParser.cpp
+        include/JavaObject/type/object/parsers/descriptor/ClassDescriptorParser.h
+        src/type/object/types/ReferenceObject.cpp
+        include/JavaObject/type/object/types/ReferenceObject.h
+        src/type/object/parsers/ReferenceParser.cpp
+        include/JavaObject/type/object/parsers/ReferenceParser.h
+        src/type/object/types/descriptor/ClassDescriptorInfoObject.cpp
+        include/JavaObject/type/object/types/descriptor/ClassDescriptorInfoObject.h
+        src/type/object/parsers/NewClassParser.cpp
+        include/JavaObject/type/object/parsers/NewClassParser.h
+        src/type/primitive/PrimitiveTypeCodeParser.cpp
+        include/JavaObject/type/primitive/PrimitiveTypeCodeParser.h
+        src/type/primitive/types/IPrimitiveObject.cpp
+        include/JavaObject/type/primitive/types/IPrimitiveObject.h
+        src/type/HandleContainer.cpp
+        include/JavaObject/type/HandleContainer.h
+        src/type/ITypeCodeParser.cpp
+        include/JavaObject/type/ITypeCodeParser.h
+        src/type/primitive/parsers/IPrimitiveObjectParser.cpp
+        include/JavaObject/type/primitive/parsers/IPrimitiveObjectParser.h
+        src/type/primitive/types/PrimitiveByteObject.cpp
+        include/JavaObject/type/primitive/types/PrimitiveByteObject.h
+        src/type/primitive/types/PrimitiveCharObject.cpp
+        include/JavaObject/type/primitive/types/PrimitiveCharObject.h
+        src/type/primitive/types/PrimitiveDoubleObject.cpp
+        include/JavaObject/type/primitive/types/PrimitiveDoubleObject.h
+        src/type/primitive/types/PrimitiveFloatObject.cpp
+        include/JavaObject/type/primitive/types/PrimitiveFloatObject.h
+        src/type/primitive/types/PrimitiveIntegerObject.cpp
+        include/JavaObject/type/primitive/types/PrimitiveIntegerObject.h
+        src/type/primitive/types/PrimitiveLongObject.cpp
+        include/JavaObject/type/primitive/types/PrimitiveLongObject.h
+        src/type/primitive/types/PrimitiveShortObject.cpp
+        include/JavaObject/type/primitive/types/PrimitiveShortObject.h
+        src/type/primitive/types/PrimitiveBooleanObject.cpp
+        include/JavaObject/type/primitive/types/PrimitiveBooleanObject.h
+        src/type/primitive/types/PrimitiveJavaObject.cpp
+        include/JavaObject/type/primitive/types/PrimitiveJavaObject.h
+        src/type/primitive/types/PrimitiveArrayObject.cpp
+        include/JavaObject/type/primitive/types/PrimitiveArrayObject.h
+        src/type/primitive/parsers/PrimitiveByteObjectParser.cpp
+        include/JavaObject/type/primitive/parsers/PrimitiveByteObjectParser.h
+        src/type/primitive/parsers/PrimitiveCharObjectParser.cpp
+        include/JavaObject/type/primitive/parsers/PrimitiveCharObjectParser.h
+        src/type/primitive/parsers/PrimitiveDoubleObjectParser.cpp
+        include/JavaObject/type/primitive/parsers/PrimitiveDoubleObjectParser.h
+        src/type/primitive/parsers/PrimitiveFloatObjectParser.cpp
+        include/JavaObject/type/primitive/parsers/PrimitiveFloatObjectParser.h
+        src/type/primitive/parsers/PrimitiveIntegerObjectParser.cpp
+        include/JavaObject/type/primitive/parsers/PrimitiveIntegerObjectParser.h
+        src/type/primitive/parsers/PrimitiveShortObjectParser.cpp
+        include/JavaObject/type/primitive/parsers/PrimitiveShortObjectParser.h
+        src/type/primitive/parsers/PrimitiveLongObjectParser.cpp
+        include/JavaObject/type/primitive/parsers/PrimitiveLongObjectParser.h
+        src/type/primitive/parsers/PrimitiveBooleanObjectParser.cpp
+        include/JavaObject/type/primitive/parsers/PrimitiveBooleanObjectParser.h
+        include/JavaObject/type/object/ObjectTypeCodeParser.h
+        src/type/object/ObjectTypeCodeParser.cpp
 )
 
 add_library(JavaObjectStreams SHARED ${FILES})
@@ -40,4 +129,12 @@ if (JAVAOBJECTSTREAMS_BUILD_TESTS)
     add_subdirectory(tests)
 endif()
 
-unset(JAVAOBJECTSTREAMS_BUILD_TESTS CACHE)
+unset(JAVAOBJECTSTREAMS_BUILD_TESTS CACHE)
+
+option(JAVAOBJECTSTREAMS_DOCS_TARGET "Create documentation target" ON)
+
+if (JAVAOBJECTSTREAMS_DOCS_TARGET STREQUAL "ON")
+    include("${CMAKE_CURRENT_SOURCE_DIR}/cmake/doxygen.cmake")
+endif ()
+
+unset(JAVAOBJECTSTREAMS_DOCS_TARGET CACHE)

README.md

@@ -1,4 +1,11 @@
 # JavaObjectStreams
-Serialization and Deserialization which matches Java's Object streams
+A C++ library to provide serialization and deserialization of Java objects (ala ObjectInputStream and ObjectOutputStream).
 
-This allows for deserializing ObjectOutputStream-serialized files
+### JavaObjectStreams is not...
+- a Java class file parser.
+- a Java disassembler.
+---
+- ✅ Deserialization
+- ❌ Serialization (TODO)
+
+## Contributing

cmake/doxygen.cmake

@@ -0,0 +1,23 @@
+include(FetchContent)
+# https://github.com/jothepro/doxygen-awesome-css?tab=readme-ov-file#cmake-with-fetchcontent
+FetchContent_Declare(
+        doxygen-awesome-css
+        URL https://github.com/jothepro/doxygen-awesome-css/archive/refs/heads/main.zip
+)
+FetchContent_MakeAvailable(doxygen-awesome-css)
+
+FetchContent_GetProperties(doxygen-awesome-css SOURCE_DIR AWESOME_CSS_DIR)
+
+FIND_PACKAGE(Doxygen)
+IF (DOXYGEN_FOUND)
+    set(DOXYFILE_IN "${CMAKE_CURRENT_SOURCE_DIR}/docs/Doxyfile.in")
+    set(DOXYFILE_OUT "${CMAKE_CURRENT_BINARY_DIR}/Doxyfile")
+
+    CONFIGURE_FILE(${DOXYFILE_IN} ${DOXYFILE_OUT} @ONLY)
+
+    ADD_CUSTOM_TARGET(JavaOutputStreams.Documentation
+            COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYFILE_OUT}
+            WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
+            VERBATIM
+    )
+ENDIF ()