4 Star 2 Fork 0

学艺不精的安东 / AntonaStandard

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

AntonaStandard

介绍

概述

C++ 基础库,供学习C++底层原理以及CMake构建原理使用。目前支持数学分数库、基础反射机制、基础委托机制、跨平台动态库热加载、跨平台套接字库封装、支持ipv4 和ipv6 的TCP-UDP套接字高级封装。文档方面全面支持 Doxygen 文档。构建方面支持cmake find_package 的 Configure 模式。拥有单元测试,支持 CTest 和 Google Test 拥有比较完善的单元测试构建体系,但目前单元测试代码相对匮乏,欢迎参与本项目贡献基于Google Test 的单元测试代码!😉🙌

子项目

子项目被放置在根目录中的 thrid_party 目录下,其它有关子项目的具体信息可以查看项目根目录的 .gitmodules 文件

  • Google Test

    • 本项目基于 1.14.x 版本的Google Test 实现单元测试,而 Google Test 是以子模块的形式引入本项目的,通过设置选项 -DBUILD_TESTS=ON 可以自动构建 Google Test 并与 AntonaStandard 安装到同一个目录下
  • doxygen-awesome-css

    • 该项目用于 美化Doxygen 文档

文档

在线文档
本地生成文档
  • AntonaStandard 支持 Doxygen 自动生成文档:

    # 切换到根目录
    doxygen Doxyfile
  • 文档的 html 文件会生成在 docs/Doxygen/html 目录下。用浏览器打开该目录中的 index.html 即可浏览文档

克隆仓库

  • 需要使用 --recurse-submodule 选项同时克隆依赖的模块 (Google Test等)

    git clone --branch master --recurse-submodule https://gitee.com/ordinaryAnton/antona-standard.git AntonaStandard
  • 如果忘记了添加 --recurse-submodule 选项,也可以等待主项目克隆完毕后,进入项目目录使用以下命令克隆子项目

    git submodule update --recursive --remote

安装教程

  • 项目主要目录

    .
    ├── AntonaStandardConfig.cmake.in
    ├── AntonaStandardInfo.h.in
    ├── CMakeLists.txt
    ├── CPS
    ├── Globals
    ├── Improvement Report.md
    ├── LICENSE
    ├── Math
    ├── Network
    ├── README.en.md
    ├── README.md
    ├── TestingSupport
    ├── ThreadTools
    ├── Utilities
    ├── cmake_uninstall.cmake.in
    ├── docs
    ├── testing_set
    └── third_party

Linux(Ubuntu 22.04):

  • 创建一个目录用于构建

    mkdir buildlin
    cd buildlin
  • 运行 cmake 命令构建项目

    cmake .. -DBUILD_EXAMPLES=ON -DBUILD_TESTS=ON -DCMAKE_INSTALL_PREFIX=<path to install>
    • -DBUILD_EXAMPLES=ON :允许构建示例程序,示例程序会生成在对应组件目录下的 bin 目录中
    • -DBUILD_TESTS=ON :允许构建单元测试,同时还会编译Google Test
    • -DCMAKE_INSTALL_PREFIX=<path to install :设置安装目录,如果不加该选项,默认安装到 /usr/local 目录下
  • 运行 make 进行构建

    make -j 16
  • 运行单元测试

    make test
  • 安装

    make install
  • 卸载方法

    make uninstall

Windows(10):

  • 首先打开 PowerShell

  • 创建一个目录用于构建

    mkdir buildlin
    cd buildlin
  • 运行 cmake

    cmake .. -G 'MinGW Makefiles' -DBUILD_EXAMPLES=ON -DBUILD_TESTS=ON -DCMAKE_INSTALL_PREFIX=<path to install>
    • -G "MinGW Makefiles" :本项目还未对其它构建系统如 MSVCLLVM 进行测试,暂且只确定支持 GNU 以及 MinGW

    • -DBUILD_EXAMPLES=ON :允许构建示例程序,示例程序会生成在对应组件目录下的 bin 目录中

    • -DBUILD_TESTS=ON :允许构建单元测试,同时还会编译Google Test

    • -DCMAKE_INSTALL_PREFIX=<path to install :设置安装目录,如果不加该选项,默认安装到 C:/Program Files (x86)/AntonaStandard 目录下

  • 运行 make 进行构建

    mingw32-make -j 16
  • 运行单元测试

    mingw32-make test
  • 安装

    mingw32-make install
  • 卸载方法

    mingw32-make uninstall

简单使用

  • CMakeLists.txt

    cmake_minimum_required(VERSION 3.15)
    
    #set(CMAKE_PREFIX_PATH ...../lib/cmake) 如果运行cmake时使用了-DCMAKE_INSTALL_PREFIX 选项则需要在这里设置packge查找路径
    
    find_package(
        AntonaStandard
        11.0.0
        REQUIRED
        Math
        Math.static
    )
    
    add_executable(demo_math_static demo_math_static.cpp)
    add_executable(demo_math demo_math.cpp)
    
    target_link_libraries(
        demo_math_static
        PUBLIC
        AntonaStandard::Math.static
    )
    
    target_link_libraries(
        demo_math
        PUBLIC
        AntonaStandard::Math
    )
  • demo_math.cppdemo_math_static.cpp

    #include <iostream>
    #include <Math/Fraction.h>
    using namespace std;
    using namespace AntonaStandard::Math;
    int main(){
        Fraction f1 = "1/2";
        Fraction f2 = "1/3";
        cout<<f1-f2<<endl;
        return 0;
    }
    

历史版本

2022/12/30 AntonaStandard-v-1.0.0 添加了常用异常类库Exception.h和事件委托类库Delegate.h

2023/1/1 AntonaStandard-v-1.0.1 更新了Delegate.h详细请看具体文档

2023/1/1 AntonaStandard-v-1.1.0 更新了Delegate.h详细请看具体文档

2023/1/2 AntonaStandard-v-2.0.0 添加反射机制类库Reflection.h详细请看具体文档

2023/1/11 AntonaStandard-v-3.0.0 添加迭代器工具库Antona_foreach.h详细请看具体文档

2023/2/19 AntonaStandard-v-4.0.0 添加自动结点类库详细请看具体文档

2023/2/25 AntonaStandard-v-4.1.0 更新自动结点库,异常库

2023/2/27 AntonaStandard-v-5.0.0 添加AntonaStandard::AntonaMath库中的Fraction分数类库

2023/3/31 AntonaStandard-v-6.0.0 添加运行时类型识别库——过滤器Filter,实现RTTI以及处理

2023/4/12 AntonaStandard-v-7.0.0 添加线程并发工具库——信号量扩展,基于C++20 semaphore库,实现And信号量请求,与信号量集请求

2023/7/9 AntonaStandard-v-7.1.0 完善了cmake构建文件,可以根据平台的不同构建不同版本的库文件和示例源文件。同时对反射库Rflection 类型过滤器Filter 信号量扩展Sem_Extension进行了一定的修改

2023/8/8 AntonaStandard-v-8.0.0 修改大量文件的命名空间,修改了include下的文件结构,新增线程池库

2023/8/11 AntonaStandard-v-8.0.1 添加 .gitignore 文件,忽略bin目录和build目录以及 lib (这意味着自版本 v-8.0.1起不再提供提前编译好的库文件)

2023/8/17 AntonaStandard-v-9.0.0 .gitignore新增需要git忽略的目录,新增跨平台支持(目前添加支持跨平台的动态库显式加载(热加载)的API),更新异常库,同时优化了文件目录

2023/9/15 AntonaStandard-v-9.1.0-Beta .gitignore新增需要git忽略的目录,新增跨平台支持:跨平台的TCP/IPV4 套接字通信,当前版本为测试版本,后续版本可能对封装的套接字库接口有加大的改动

2023/9/16 AntonaStandard-v-9.1.0 重新设计了封装了ip地址和端口的类,实现简单易用的跨平台的TCP/IPV4 以及 TCP/IPV6 套接字通信方案

2023/10/24 AntonaStandard-v-9.2.0 过渡版本

2023/11/10 AntonaStandard-v-10.0.0 引入基于Google Test 的单元测试,保障代码的健壮性。使用智能指针替代裸指针,降低内存泄漏的风险。

2023/12/12 AntonaStandard-v-10.0.1 完成MultiPlatformSupport::SocketSupport 的UDP 基础功能

2024/2/25 AntonaStandard-v-11.0.0 完成对cmake module 的支持、完成对 CTest 和 Google Test 自动支持、完成ipv4 和ipv6 的TCP-UDP套接字高级封装(Network 组件)

2024/3/7 AntonaStandard-v-11.0.1 支持Doxygen 自动生成文档

原作者博客

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

供学习C++底层原理和CMake构建的C++基础库 展开 收起
C++ 等 4 种语言
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
C++
1
https://gitee.com/ordinaryAnton/antona-standard.git
git@gitee.com:ordinaryAnton/antona-standard.git
ordinaryAnton
antona-standard
AntonaStandard
master

搜索帮助