cppiniter 1.0.7__tar.gz → 1.1.0__tar.gz

{cppiniter-1.0.7/cppiniter.egg-info → cppiniter-1.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cppiniter
-Version: 1.0.7
+Version: 1.1.0
 Summary: C++项目脚手架
 Home-page: https://github.com/xyz1001/cppiniter
 Author: xyz1001

{cppiniter-1.0.7 → cppiniter-1.1.0}/README.md

@@ -21,12 +21,12 @@ pip3 install cppiniter
 
 ```
 Usage:
-    cppiniter [<dir>] [--name=<name>] [--lib]
+    cppiniter [<dir>] [--name=<name>] [--exe]
 
 Options:
     <dir>                   项目目录，默认为当前目录
     --name=<name>           项目名，默认为项目目录名
-    --lib                   项目目标为C++库
+    --exe                   项目目标为C++应用程序，默认为库
 ```
 
 ## 目录结构
@@ -60,6 +60,12 @@ project
 │   │
 │   └── main.cpp # 加快doctest的编译速度
 │
+├── example # 所有的示例程序文件应该放在这个目录下面
+│   │
+│   ├── CMakeLists.txt
+│   │
+│   └── main.cpp
+│
 ├── doc # 文档保存目录
 │
 └── build # 我们应该保持一棵干净的源码树，所有编译动作应该单独在这个目录进行。这个目录应加入gitignore

{cppiniter-1.0.7 → cppiniter-1.1.0}/cppiniter/cppiniter.py

@@ -4,12 +4,12 @@
 """cppiniter init a cpp project struction
 
 Usage:
-    cppiniter [<dir>] [--name=<name>] [--lib]
+    cppiniter [<dir>] [--name=<name>] [--exe]
 
 Options:
     <dir>                   项目目录，默认为当前目录
     --name=<name>           项目名，默认为项目目录名
-    --lib                   项目目标为C++库
+    --exe                   项目目标为C++应用程序，默认为库
 """
 
 import os
@@ -24,12 +24,15 @@ from datetime import datetime
 
 IGNORE_FILES = set([".git", "LICENSE"])
 EMPTY_DIR = ("build", "doc")
+RENAME_FILES = {"src/project_name/project_name.h": "src/project_name/{{project_name}}.h", "src/project_name/project_name.cpp": "src/project_name/{{project_name}}.cpp", "src/project_name": "src/{{project_name}}"}
 
 
 def install(args):
     ignores = ["*.pyc", "__pycache__"]
-    if args["is_lib"]:
-        ignores.append("src/main.cpp")
+
+    if args["is_exe"]:
+        ignores.append("example")
+        ignores.append("test")
 
     dir = os.path.dirname(os.path.realpath(__file__))
     shutil.copytree(os.path.join(dir, "files"),
@@ -38,6 +41,16 @@ def install(args):
                     dirs_exist_ok=True)
     for i in EMPTY_DIR:
         os.mkdir(os.path.join(args["project_dir"], i))
+    for key, value in RENAME_FILES.items():
+        src_path = os.path.join(args["project_dir"], key)
+        dst_path = os.path.join(args["project_dir"], pystache.render(value, args))
+        os.rename(src_path, dst_path)
+
+    if args["is_exe"]:
+        shutil.rmtree(os.path.join(args["project_dir"], "src", args["project_name"]))
+    else:
+        os.remove(os.path.join(args["project_dir"], "src", "main.cpp"))
+        os.remove(os.path.join(args["project_dir"], "src", "version.h.in"))
 
 
 def render(dir, args):
@@ -56,7 +69,7 @@ def render(dir, args):
 def preprocess(args):
     project_dir = args["<dir>"]
     project_name = args["--name"]
-    is_lib = args["--lib"]
+    is_exe = args["--exe"]
     author = subprocess.check_output(["git", "config", "--get", "user.name"]
                                      ).decode(sys.stdout.encoding).strip()
     email = subprocess.check_output(["git", "config", "--get", "user.email"]
@@ -84,7 +97,7 @@ def preprocess(args):
 
     project_name_uppercase = project_name.upper()
     project_name_camelcase = ''.join(project_name.title() for word in project_name.split('_'))
-    return {"project_name": project_name, "project_name_uppercase": project_name_uppercase, "project_name_camelcase": project_name_camelcase, "project_dir": project_dir, "is_lib": is_lib, "date_time": date_time, "author": author, "email": email}
+    return {"project_name": project_name, "project_name_uppercase": project_name_uppercase, "project_name_camelcase": project_name_camelcase, "project_dir": project_dir, "is_exe": is_exe, "date_time": date_time, "author": author, "email": email}
 
 
 def execute(dir):

{cppiniter-1.0.7 → cppiniter-1.1.0}/cppiniter/files/.clang-tidy

@@ -10,6 +10,9 @@ Checks: "*,
         -hicpp-special-member-functions,
         -readability-identifier-length,
         -misc-no-recursion,
+        -hicpp-no-array-decay,
+        -cppcoreguidelines-pro-bounds-array-to-pointer-decay,
+        -llvm-include-order,
 "
 WarningsAsErrors: ''
 HeaderFilterRegex: ''

{cppiniter-1.0.7 → cppiniter-1.1.0}/cppiniter/files/CMakeLists.txt

@@ -2,7 +2,7 @@
 # Automatically generated by cppiniter {{{date_time}}}
 ######################################################################
 
-cmake_minimum_required (VERSION 3.23)
+cmake_minimum_required (VERSION 3.25)
 project ({{{project_name}}})
 
 include(GNUInstallDirs)
@@ -21,6 +21,9 @@ if(NOT DEFINED VERSION_NAME)
 
     set(VERSION_NAME "T.${MAJOR_VERSION}.${MINOR_VERSION}.${PATCH_VERSION}.0")
 endif()
+if(DEFINED ENV{GIT_COMMIT})
+    set(VERSION_NAME "${VERSION_NAME}-$ENV{GIT_COMMIT}")
+endif()
 message(STATUS "${PROJECT_NAME} version ${VERSION_NAME}")
 add_definitions(-DVERSION_NAME="${VERSION_NAME}")
 
@@ -35,6 +38,8 @@ set(CMAKE_C_VISIBILITY_PRESET hidden)
 set(CMAKE_CXX_VISIBILITY_PRESET hidden)
 set(CMAKE_VISIBILITY_INLINES_HIDDEN ON)
 
+set(CMAKE_COMPILE_WARNING_AS_ERROR ON)
+
 if(WIN32)
     add_definitions(-DWINVER=0x0601)
     add_definitions(-D_WIN32_WINNT=0x0601)
@@ -42,35 +47,60 @@ endif()
 
 
 if ("${CMAKE_CXX_COMPILER_ID}" MATCHES "Clang")
-    set(CMAKE_CXX_FLAGS_DEBUG "$ENV{CXXFLAGS} ${CMAKE_CXX_FLAGS_DEBUG} -Og -g3 -Werror -Wall -Wextra -Wno-sign-compare")
+    set(CMAKE_CXX_FLAGS_DEBUG "$ENV{CXXFLAGS} ${CMAKE_CXX_FLAGS_DEBUG} -Og -g3 -Wall -Wextra -Wno-sign-compare")
     set(CMAKE_CXX_FLAGS_RELEASE "$ENV{CXXFLAGS} ${CMAKE_CXX_FLAGS_RELEASE} -O2")
 elseif("${CMAKE_CXX_COMPILER_ID}" STREQUAL "GNU")
-    set(CMAKE_CXX_FLAGS_DEBUG "$ENV{CXXFLAGS} ${CMAKE_CXX_FLAGS_DEBUG} -Og -g3 -Werror -Wall -Wextra -Wno-sign-compare")
+    set(CMAKE_CXX_FLAGS_DEBUG "$ENV{CXXFLAGS} ${CMAKE_CXX_FLAGS_DEBUG} -Og -g3 -Wall -Wextra -Wno-sign-compare")
     set(CMAKE_CXX_FLAGS_RELEASE "$ENV{CXXFLAGS} ${CMAKE_CXX_FLAGS_RELEASE} -O2")
+    set(CMAKE_SHARED_LINKER_FLAGS "${CMAKE_SHARED_LINKER_FLAGS} -Wl,--exclude-libs,ALL")
 elseif ("${CMAKE_CXX_COMPILER_ID}" STREQUAL "MSVC")
     add_definitions(-D_SCL_SECURE_NO_WARNINGS=1)
     add_definitions(-D_CRT_SECURE_NO_WARNINGS=1)
 
-    set(CMAKE_VS_INCLUDE_INSTALL_TO_DEFAULT_BUILD TRUE)
-
     string (REGEX REPLACE "/W[0-4]" "/W4" CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS}")
     set(CMAKE_CXX_FLAGS "$ENV{CXXFLAGS} ${CMAKE_CXX_FLAGS} /EHsc /utf-8 /MP /Zc:__cplusplus")
-    set(CMAKE_CXX_FLAGS_DEBUG "$ENV{CXXFLAGS} ${CMAKE_CXX_FLAGS_DEBUG}  /WX /wd4244 /wd4018 /wd4267 /wd4307")
-    set(CMAKE_CXX_FLAGS_RELEASE "$ENV{CXXFLAGS} ${CMAKE_CXX_FLAGS_RELEASE} /Zi")
+    set(CMAKE_CXX_FLAGS_DEBUG "$ENV{CXXFLAGS} ${CMAKE_CXX_FLAGS_DEBUG} /wd4244 /wd4018 /wd4267 /wd4307")
+    if (BUILD_SHARED_LIBS)
+        set(CMAKE_CXX_FLAGS_RELEASE "$ENV{CXXFLAGS} ${CMAKE_CXX_FLAGS_RELEASE} /Zi")
+    else()
+        string (REGEX REPLACE "/Zi" "/Z7" CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG}")
+        set(CMAKE_CXX_FLAGS_RELEASE "$ENV{CXXFLAGS} ${CMAKE_CXX_FLAGS_RELEASE} /Z7")
+    endif()
+
 
     set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} /SAFESEH:NO")
     set(CMAKE_SHARED_LINKER_FLAGS_RELEASE "${CMAKE_SHARED_LINKER_FLAGS_RELEASE} /DEBUG /OPT:REF /OPT:ICF")
 endif()
 
 if (CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT)
-    set(CMAKE_INSTALL_PREFIX ${CMAKE_SOURCE_DIR}/build/install/ CACHE PATH "default install prefix" FORCE)
+    set(CMAKE_INSTALL_PREFIX ${CMAKE_BINARY_DIR}/install/ CACHE PATH "default install prefix" FORCE)
 endif()
 
-option(BUILD_TEST "build tests" OFF)
+{{^is_exe}}
+option(BUILD_TEST "build test" OFF)
+option(BUILD_EXAMPLE "build example" OFF)
+{{/is_exe}}
 
 add_subdirectory(src)
-{{#is_lib}}
+{{^is_exe}}
 if(BUILD_TEST)
     add_subdirectory (test)
 endif()
-{{/is_lib}}
+
+if(BUILD_EXAMPLE)
+    add_subdirectory (example)
+endif()
+
+if (BUILD_EXAMPLE OR BUILD_TEST)
+    if (WIN32)
+        set(CMAKE_INSTALL_UCRT_LIBRARIES TRUE)
+        set(CMAKE_INSTALL_DEBUG_LIBRARIES TRUE)
+
+        file(GLOB DLLS ${CMAKE_BINARY_DIR}/*.dll)
+        INSTALL(FILES ${DLLS} DESTINATION bin)
+    elseif(APPLE)
+        file(GLOB DYLIBS ${CMAKE_BINARY_DIR}/*.dylib)
+        INSTALL(FILES ${DYLIBS} DESTINATION lib)
+    endif()
+endif()
+{{/is_exe}}

{cppiniter-1.0.7 → cppiniter-1.1.0}/cppiniter/files/conanfile.py

@@ -1,7 +1,7 @@
 from conan import ConanFile
 from conan.tools.cmake import CMake, cmake_layout, CMakeToolchain, CMakeDeps
 from conan.tools.scm import Git
-from conan.tools.files import update_conandata
+from conan.tools.files import update_conandata, copy
 import os
 
 
@@ -17,7 +17,8 @@ class {{{project_name_camelcase}}}Conan(ConanFile):
     options = {"shared": [True, False], "test": [True, False]}
     default_options = {"shared": True, "test": False}
 
-    def _make_version(self):
+    @property
+    def version_name(self):
         type_dict = {"stable": "R", "snapshot": "D", "testing": "T"}
         type = type_dict.get(self.channel, "S")
         hash = os.getenv("GIT_COMMIT", "")[:6]
@@ -46,14 +47,26 @@ class {{{project_name_camelcase}}}Conan(ConanFile):
         cmake_layout(self)
 
     def generate(self):
-        tc = CMakeToolchain(self)
-        tc.variables["VERSION_NAME"] = self._make_version()
+        if self.settings.os == "Windows":
+            tc = CMakeToolchain(self, generator="Ninja")
+        else:
+            tc = CMakeToolchain(self)
+
+        if self.version:
+            tc.variables["VERSION_NAME"] = self.version_name
         tc.variables["BUILD_TEST"] = self.options.test
         tc.generate()
 
         deps = CMakeDeps(self)
         deps.generate()
 
+        if self.settings.os == "Windows":
+            for dep in self.dependencies.values():
+                for bindir in dep.cpp_info.bindirs:
+                    copy(self, "*.dll", bindir, self.build_folder)
+                    copy(self, "*.dylib", bindir, self.build_folder)
+
+
     def build(self):
         cmake = CMake(self)
         cmake.configure()

cppiniter-1.1.0/cppiniter/files/example/CMakeLists.txt

@@ -0,0 +1,15 @@
+######################################################################
+# Automatically generated by cppiniter {{{date_time}}}
+######################################################################
+
+add_executable(example)
+
+target_include_directories(example INTERFACE ${CMAKE_CURRENT_LIST_DIR})
+
+file(GLOB SRC "*/*.h"
+              "*/*.cpp"
+              "*.hpp"
+              "*.cpp")
+target_sources(example PRIVATE ${SRC})
+
+target_link_libraries(${TARGET} PRIVATE {{{project_name}}})

{cppiniter-1.0.7/cppiniter/files/src → cppiniter-1.1.0/cppiniter/files/example}/main.cpp

@@ -4,9 +4,6 @@
  * coding: utf-8
  */
 
-#include <iostream>
-
-int main() {
-
+int main(int argc, char *argv[]) {
     return 0;
 }

cppiniter-1.1.0/cppiniter/files/src/CMakeLists.txt

@@ -0,0 +1,43 @@
+######################################################################
+# Automatically generated by cppiniter {{{date_time}}}
+######################################################################
+
+{{#is_exe}}
+add_executable({{{project_name}}})
+{{/is_exe}}
+{{^is_exe}}
+add_library({{{project_name}}})
+
+if(BUILD_SHARED_LIBS)
+    target_compile_definitions({{{project_name}}} PRIVATE {{{project_name_uppercase}} {{{project_name_uppercase}}_EXPORTS)
+endif()
+{{/is_exe}}
+
+target_include_directories({{{project_name}}} PUBLIC ${CMAKE_CURRENT_LIST_DIR} ${CMAKE_BINARY_DIR})
+
+{{#is_exe}}
+configure_file(${CMAKE_CURRENT_LIST_DIR}/version.h.in ${CMAKE_BINARY_DIR}/version.h)
+{{/is_exe}}
+{{^is_exe}}
+configure_file(${CMAKE_CURRENT_LIST_DIR}/{{{project_name}}}/version.h.in ${CMAKE_BINARY_DIR}/version.h)
+{{/is_exe}}
+list(APPEND SRC ${CMAKE_CURRENT_LIST_DIR}/{{{project_name}}}/version.cpp)
+
+file(GLOB SRC "*/*.h"
+              "*/*.cpp"
+              "*.hpp"
+              "*.cpp")
+target_sources({{{project_name}}} PRIVATE ${SRC})
+
+find_package(fmt REQUIRED CONFIG)
+
+target_link_libraries(${TARGET} fmt::fmt)
+
+INSTALL(TARGETS {{{project_name}}}
+        RUNTIME DESTINATION bin
+        LIBRARY DESTINATION lib
+        ARCHIVE DESTINATION lib)
+
+if(MSVC AND BUILD_SHARED_LIBS)
+    install(FILES $<TARGET_PDB_FILE:{{{project_name}}}> DESTINATION lib)
+endif()

cppiniter-1.1.0/cppiniter/files/src/main.cpp

@@ -0,0 +1,14 @@
+/*
+ * author: {{{author}}} <{{{email}}}>
+ * created at: {{{date_time}}}
+ * coding: utf-8
+ */
+
+#include <iostream>
+
+#include "version.h"
+
+int main() {
+    std::cout << kVersionName << std::endl;
+    return 0;
+}

cppiniter-1.1.0/cppiniter/files/src/project_name/export.h

@@ -0,0 +1,36 @@
+#pragma once
+
+// clang-format off
+// Generic helper definitions for shared library support
+#if defined _WIN32 || defined __CYGWIN__
+  #define {{{project_name_uppercase}}}_HELPER_DLL_IMPORT __declspec(dllimport)
+  #define {{{project_name_uppercase}}}_HELPER_DLL_EXPORT __declspec(dllexport)
+  #define {{{project_name_uppercase}}}_HELPER_DLL_LOCAL
+#else
+  #if __GNUC__ >= 4
+    #define {{{project_name_uppercase}}}_HELPER_DLL_IMPORT __attribute__ ((visibility ("default")))
+    #define {{{project_name_uppercase}}}_HELPER_DLL_EXPORT __attribute__ ((visibility ("default")))
+    #define {{{project_name_uppercase}}}_HELPER_DLL_LOCAL  __attribute__ ((visibility ("hidden")))
+  #else
+    #define {{{project_name_uppercase}}}_HELPER_DLL_IMPORT
+    #define {{{project_name_uppercase}}}_HELPER_DLL_EXPORT
+    #define {{{project_name_uppercase}}}_HELPER_DLL_LOCAL
+  #endif
+#endif
+
+// Now we use the generic helper definitions above to define {{{project_name_uppercase}}}_API and {{{project_name_uppercase}}}_LOCAL.
+// {{{project_name_uppercase}}}_API is used for the public API symbols. It either DLL imports or DLL exports (or does nothing for static build)
+// {{{project_name_uppercase}}}_LOCAL is used for non-api symbols.
+
+#ifdef {{{project_name_uppercase}}}_DLL // defined if {{{project_name_uppercase}}} is compiled as a DLL
+  #ifdef {{{project_name_uppercase}}}_DLL_EXPORTS // defined if we are building the {{{project_name_uppercase}}} DLL (instead of using it)
+    #define {{{project_name_uppercase}}}_API {{{project_name_uppercase}}}_HELPER_DLL_EXPORT
+  #else
+    #define {{{project_name_uppercase}}}_API {{{project_name_uppercase}}}_HELPER_DLL_IMPORT
+  #endif // {{{project_name_uppercase}}}_DLL_EXPORTS
+  #define {{{project_name_uppercase}}}_LOCAL {{{project_name_uppercase}}}_HELPER_DLL_LOCAL
+#else // {{{project_name_uppercase}}}_DLL is not defined: this means {{{project_name_uppercase}}} is a static lib.
+  #define {{{project_name_uppercase}}}_API
+  #define {{{project_name_uppercase}}}_LOCAL
+#endif // {{{project_name_uppercase}}}_DLL
+// clang-format on

cppiniter-1.1.0/cppiniter/files/src/project_name/version.h.in

@@ -0,0 +1,11 @@
+/*
+ * author: {{{author}}} <{{{email}}}>
+ * created at: {{{date_time}}}
+ * coding: utf-8
+ */
+
+#pragma once
+
+#include <string>
+
+constexpr const char *kVersionName = "@VERSION_NAME@";

cppiniter-1.1.0/cppiniter/files/src/version.h.in

@@ -0,0 +1,11 @@
+/*
+ * author: {{{author}}} <{{{email}}}>
+ * created at: {{{date_time}}}
+ * coding: utf-8
+ */
+
+#pragma once
+
+#include <string>
+
+constexpr const char *kVersionName = "@VERSION_NAME@";

{cppiniter-1.0.7 → cppiniter-1.1.0/cppiniter.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cppiniter
-Version: 1.0.7
+Version: 1.1.0
 Summary: C++项目脚手架
 Home-page: https://github.com/xyz1001/cppiniter
 Author: xyz1001

{cppiniter-1.0.7 → cppiniter-1.1.0}/cppiniter.egg-info/SOURCES.txt

@@ -19,7 +19,14 @@ cppiniter/files/CMakeSettings.json
 cppiniter/files/README.md
 cppiniter/files/conanfile.py
 cppiniter/files/version.properties
+cppiniter/files/example/CMakeLists.txt
+cppiniter/files/example/main.cpp
 cppiniter/files/src/CMakeLists.txt
 cppiniter/files/src/main.cpp
+cppiniter/files/src/version.h.in
+cppiniter/files/src/project_name/export.h
+cppiniter/files/src/project_name/project_name.cpp
+cppiniter/files/src/project_name/project_name.h
+cppiniter/files/src/project_name/version.h.in
 cppiniter/files/test/CMakeLists.txt
 cppiniter/files/test/main.cpp

{cppiniter-1.0.7 → cppiniter-1.1.0}/setup.py

@@ -5,7 +5,7 @@ from setuptools import setup
 
 setup(
     name='cppiniter',
-    version="1.0.7",
+    version="1.1.0",
     description="C++项目脚手架",
     long_description="""用于提供C++项目开发环境的初始化""",
     keywords='c++ scaffolding',

cppiniter-1.0.7/cppiniter/files/src/CMakeLists.txt

@@ -1,30 +0,0 @@
-######################################################################
-# Automatically generated by cppiniter {{{date_time}}}
-######################################################################
-
-{{#is_lib}}
-add_library({{{project_name}}})
-{{/is_lib}}
-{{^is_lib}}
-add_executable({{{project_name}}})
-{{/is_lib}}
-
-target_include_directories({{{project_name}}} INTERFACE ${CMAKE_CURRENT_LIST_DIR})
-
-file(GLOB SRC "*/*.h"
-              "*/*.cpp"
-              "*.hpp"
-              "*.cpp")
-target_sources({{{project_name}}} PRIVATE ${SRC})
-
-find_package(fmt REQUIRED CONFIG)
-
-target_link_libraries(${TARGET} fmt::fmt)
-
-target_link_libraries({{{project_name}}} ${CONAN_LIBS})
-
-# install
-INSTALL(TARGETS {{{project_name}}}
-        RUNTIME DESTINATION bin
-        LIBRARY DESTINATION lib
-        ARCHIVE DESTINATION lib)