• 1. 问题
• 2. 推荐理由
• 3. 项目官方介绍
  • 3.1. Source code
  • 3.2. Overview
  • 3.3. Library Features
  • 3.4. Testing Platforms
  • 3.5. Related Documents
  • 3.6. 源码仓库
  • 3.7. 概述
  • 3.8. 设计特点
  • 3.9. 已验证的平台
  • 3.10. 相关文档

1. 问题

在知乎上看到一个问题

有哪些轻量级适合阅读的优秀 C++ 开源项目？

代码风格比较好，代码量在5000左右，短小精悍，结构清晰，谢谢推荐。

说明有不少同学，是希望能有一个轻量级、质量高、C++实现的开源项目，通过这样一个项目来进一步学习C++的一些基础知识，并能够快速阅读、理解和应用。

借着这个问题，我来推荐一个开源项目： common_util。

2. 推荐理由

1. 代码量适中： 开源库代码3000+行，Demo 700+行，总代码约4000行，符合同学们的需求。
2. 轻量极简： 基于基础C++语法和STL，不依赖任何第三方库。
3. 多平台支持： 支持Linux/OS-X/Windows等多个平台，一套代码多平台编译。
4. 代码整洁： 代码风格整洁，命名方式与STL保持一致，你可以像使用STL一样使用本库。
5. 文档规范全面： 所有对外接口的头文件都有详细的代码注释，且有完整的API文档和使用Demo，可供查阅。
6. C++版本要求： C++11及以上版本。

3. 项目官方介绍

3.1. Source code

3.2. Overview

common_util is a general-purpose C++ utility library, include the following functions:

• Time utilities
• Function timer
• Filepath utilities
• Filesystem utilities
• String utilities
• Data formatting
• Singleton pattern macro definition

common_util is implemented in modern C++ syntax (C++11 and above), using cutl as the namespace. The naming convention of all interfaces is consistent with the STL, and it can be used as an extensions of C++ standard library. You can use common_util just like using the STL, For example:

1
2
3
4
5
6
7
8

// Data formatting
std::cout << "fmt_uint: " << cutl::fmt_uint(12, 5) << std::endl;
std::cout << "fmt_double: " << cutl::fmt_double(3.141592653, 4) << std::endl;
std::cout << "fmt_filesize: " << cutl::fmt_filesize(33600) << std::endl;
// Get the current system time
auto now = cutl::datetime::now();
std::cout << "current time(UTC time): " << now.utctime() << std::endl;
std::cout << "current time(local time): " << now.format() << std::endl;

3.3. Library Features

• Simple and lightweigh: Based on basic C++ syntax and STL, it independent on any third-party libraries.
• Multi-platform support: Supports multiple platforms such as Linux/macOS/Windows, it can be compiled and run on multiple platforms.
• Clean code: The code style is clean, and the naming convention is consistent with the STL, you can use this library just like use the C++ standard library.
• Comprehensive documentation: All exported header files have detail comments, it has complete API reference and usage demos.
• C++ version requirement: C++11 and above versions.

3.4. Testing Platforms

This library has been tested and verified on the following platforms:

3.5. Related Documents

• off-line: docs/reference/html/index.html
• on line : http://sunlogging.com/docs/common_util/

3.6. 源码仓库

3.7. 概述

common_util是C++的一个通用工具库，主要包含以下功能：

• 时间处理
• 函数计时器
• 路径处理
• 文件操作
• 字符串处理
• 数据格式化
• 单例模式宏定义

common_util采用现代C++语法（C++11及以上）实现，使用cutl作为命名空间，所有接口的命名方式与STL保持一致，可以作为STL库的一个补充。你可以像使用STL一样使用common_util，如：

1
2
3
4
5
6
7
8

// 数据格式化
std::cout << "fmt_uint: " << cutl::fmt_uint(12, 5) << std::endl;
std::cout << "fmt_double: " << cutl::fmt_double(3.141592653, 4) << std::endl;
std::cout << "fmt_filesize: " << cutl::fmt_filesize(33600) << std::endl;
// 获取系统当前时间
auto now = cutl::datetime::now();
std::cout << "current time(UTC time): " << now.utctime() << std::endl;
std::cout << "current time(local time): " << now.format() << std::endl;

3.8. 设计特点

• 轻量极简： 基于基础C++语法和STL，不依赖任何第三方库。
• 多平台支持： 支持Linux/OS-X/Windows等多个平台，一套代码多平台编译。
• 代码整洁： 代码风格整洁，命名方式与STL保持一致，你可以像使用STL一样使用本库。
• 文档规范全面： 所有对外接口的头文件都有详细的代码注释，且有完整的API文档和使用Demo，可供查阅。
• C++版本要求： C++11及以上版本。

3.9. 已验证的平台

本库在以下平台上测试验证过：

3.10. 相关文档

• 离线文档: docs/reference/html/index.html
• 在线文档: http://sunlogging.com/docs/common_util/