Merge pull request #1 from p-ranav/feature/cmake_cleanup

Feature/cmake cleanup

Author: p-ranav

CMakeLists.txt

@@ -1,59 +1,75 @@
-cmake_minimum_required(VERSION 3.6)
-project(GLOB)
+cmake_minimum_required(VERSION 3.14 FATAL_ERROR)
 
-if(NOT CMAKE_BUILD_TYPE)
-  set(CMAKE_BUILD_TYPE Release)
-endif()
+# ---- Project ----
+
+# Note: update this to your new project's name and version
+project(
+  Glob
+  VERSION 1.0
+  LANGUAGES CXX
+)
 
-set(CMAKE_CXX_FLAGS "-Wall -Wextra")
-set(CMAKE_CXX_FLAGS_DEBUG "-g")
-set(CMAKE_CXX_FLAGS_RELEASE "-O3")
+# ---- Include guards ----
 
-# Disable deprecation for windows
-if (WIN32)
-  add_compile_definitions(_CRT_SECURE_NO_WARNINGS)
+if(PROJECT_SOURCE_DIR STREQUAL PROJECT_BINARY_DIR)
+  message(
+    FATAL_ERROR
+      "In-source builds not allowed. Please make a new directory (called a build directory) and run CMake from there."
+  )
 endif()
 
-option(GLOB_BUILD_SHARED_LIBS "Build shared library" ON)
-option(GLOB_BUILD_STATIC_LIBS "Build static library" ON)
-option(GLOB_BUILD_SAMPLES "Build samples" ON)
+# ---- Add dependencies via CPM ----
+# see https://github.com/TheLartians/CPM.cmake for more info
 
-set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
-set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)
-set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)
+include(cmake/CPM.cmake)
 
-FILE(GLOB GLOB_SOURCES "src/glob.cpp")
-INCLUDE_DIRECTORIES("include")
+# PackageProject.cmake will be used to make our target installable
+CPMAddPackage(
+  NAME PackageProject.cmake
+  GITHUB_REPOSITORY TheLartians/PackageProject.cmake
+  VERSION 1.3
+)
 
-if(GLOB_BUILD_SHARED_LIBS)
-  ADD_LIBRARY(GLOB SHARED ${GLOB_SOURCES})
-  SET_TARGET_PROPERTIES(GLOB PROPERTIES OUTPUT_NAME glob)
-  TARGET_LINK_LIBRARIES(GLOB)
-  SET_PROPERTY(TARGET GLOB PROPERTY CXX_STANDARD 17)
-endif()
+# ---- Add source files ----
 
-if(GLOB_BUILD_STATIC_LIBS)
-  ADD_LIBRARY(GLOB_STATIC STATIC ${GLOB_SOURCES})
-  SET_TARGET_PROPERTIES(GLOB_STATIC PROPERTIES OUTPUT_NAME glob_static)
-  TARGET_LINK_LIBRARIES(GLOB_STATIC)
-  SET_PROPERTY(TARGET GLOB_STATIC PROPERTY CXX_STANDARD 17)
-endif()
+# Note: globbing sources is considered bad practice as CMake's generators may not detect new files
+# automatically. Keep that in mind when changing files, or explicitly mention them here.
+file(GLOB_RECURSE headers CONFIGURE_DEPENDS "${CMAKE_CURRENT_SOURCE_DIR}/include/*.h")
+file(GLOB_RECURSE sources CONFIGURE_DEPENDS "${CMAKE_CURRENT_SOURCE_DIR}/source/*.cpp")
 
-if(GLOB_BUILD_SAMPLES)
-  # GLOB_PRINT_MATCHES sample
-  ADD_EXECUTABLE(GLOB_PRINT_MATCHES "samples/glob_and_print_matches.cpp")
-  SET_TARGET_PROPERTIES(GLOB_PRINT_MATCHES PROPERTIES OUTPUT_NAME glob)
-  TARGET_LINK_LIBRARIES(GLOB_PRINT_MATCHES GLOB)
-  SET_PROPERTY(TARGET GLOB_PRINT_MATCHES PROPERTY CXX_STANDARD 17)
-
-  # GLOB_PRINT_MATCHES_RECURSIVE sample
-  ADD_EXECUTABLE(GLOB_PRINT_MATCHES_RECURSIVE "samples/rglob_and_print_matches.cpp")
-  SET_TARGET_PROPERTIES(GLOB_PRINT_MATCHES_RECURSIVE PROPERTIES OUTPUT_NAME rglob)
-  TARGET_LINK_LIBRARIES(GLOB_PRINT_MATCHES_RECURSIVE GLOB)
-  SET_PROPERTY(TARGET GLOB_PRINT_MATCHES_RECURSIVE PROPERTY CXX_STANDARD 17)
-endif()
+# ---- Create library ----
+
+# Note: for header-only libraries change all PUBLIC flags to INTERFACE and create an interface
+# target: add_library(Glob INTERFACE) set_target_properties(Glob PROPERTIES
+# INTERFACE_COMPILE_FEATURES cxx_std_17)
+
+add_library(Glob ${headers} ${sources})
+SET_TARGET_PROPERTIES(Glob PROPERTIES OUTPUT_NAME glob)
+set_target_properties(Glob PROPERTIES CXX_STANDARD 17)
+
+# being a cross-platform target, we enforce standards conformance on MSVC
+target_compile_options(Glob PUBLIC "$<$<BOOL:${MSVC}>:/permissive->")
+
+# Link dependencies (if required) target_link_libraries(Glob PUBLIC cxxopts)
+
+target_include_directories(
+  Glob PUBLIC $<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}/include>
+                 $<INSTALL_INTERFACE:include/${PROJECT_NAME}-${PROJECT_VERSION}>
+)
+
+# ---- Create an installable target ----
+# this allows users to install and find the library via `find_package()`.
+
+# the location where the project's version header will be placed should match the project's regular
+# header paths
+string(TOLOWER ${PROJECT_NAME}/version.h VERSION_HEADER_LOCATION)
 
-# make check - runs unit tests
-if (UNIX)
-  add_custom_target(check COMMAND ./tests)
-endif(UNIX)
+packageProject(
+  NAME ${PROJECT_NAME}
+  VERSION ${PROJECT_VERSION}
+  BINARY_DIR ${PROJECT_BINARY_DIR}
+  INCLUDE_DIR ${PROJECT_SOURCE_DIR}/include
+  INCLUDE_DESTINATION include/${PROJECT_NAME}-${PROJECT_VERSION}
+  VERSION_HEADER "${VERSION_HEADER_LOCATION}"
+  DEPENDENCIES ""
+)

README.md

@@ -9,17 +9,18 @@
 ## Table of Contents
 
 - [Quick Start](#quick-start)
+  * [Build Library and Standalone Sample](#build-library-and-standalone-sample)
 - [API](#api)
 - [Wildcards](#wildcards)
-- [Example](#example)
+- [Examples](#examples)
   * [Match file extensions](#match-file-extensions)
   * [Match files in absolute pathnames](#match-files-in-absolute-pathnames)
   * [Wildcards: Match a range of characters listed in brackets ('[]')](#wildcards-match-a-range-of-characters-listed-in-brackets-)
   * [Exclude files from the matching](#exclude-files-from-the-matching)
   * [Wildcards: Match any one character with question mark ('?')](#wildcards-match-any-one-character-with-question-mark-)
   * [Case sensitivity](#case-sensitivity)
 - [Contributing](#contributing)
-- [License)(#license)
+- [License](#license)
 
 ## Quick Start
 
@@ -29,11 +30,14 @@
   - If you can't use `C++17`, you can integrate [gulrak/filesystem](https://github.com/gulrak/filesystem) with minimal effort.
 * MIT License
 
+### Build Library and Standalone Sample
+
 ```bash
-git clone https://github.com/p-ranav/glob
-cd glob
-mkdir build && cd build
-cmake .. && make
+cmake -Hall -Bbuild
+cmake --build build
+
+# run standalone `glob` sample
+./build/standalone/glob --help
 ```
 
 ## API
@@ -77,28 +81,7 @@ vector<filesystem::path> rglob(vector<string> pathnames);
 | `[-]` | any character in the range listed in brackets | `[A-Z]*` matches files starting with capital letters |
 | `[!]` | any character listed in the brackets | `[!ABC]*` matches files that do not start with A,B or C |
 
-## Example
-
-Below is a short program that runs `glob` and prints matching path names.
-
-***NOTE*** Replace `glob` with `rglob` if you want to glob recursively.
-
-```cpp
-#include <glob/glob.h>
-#include <iostream>
-
-int main(int argc, char *argv[]) {
-  if (argc != 2) {
-    std::cerr << "Usage: ./exe <pattern>\n";
-    return EXIT_FAILURE;
-  }
-
-  // Run glob on the vector of patterns
-  for (auto &f : glob::glob(argv[1])) {
-    std::cout << f << "\n";
-  }
-}
-```
+## Examples
 
 ### Match file extensions
 
@@ -118,19 +101,19 @@ foo@bar:~$ tree
 
 3 directories, 7 files
 
-foo@bar:~$ ./main "**/*.hpp"
+foo@bar:~$ ./glob -i "**/*.hpp"
 "test/doctest.hpp"
 
-foo@bar:~$ ./main "**/**/*.hpp"
+foo@bar:~$ ./glob -i "**/**/*.hpp"
 "include/foo/baz.hpp"
 "include/foo/foo.hpp"
 "include/foo/bar.hpp"
 ```
 
-***NOTE*** If you use `rglob` instead of `glob`:
+***NOTE*** If you run glob recursively, i.e., using `rglob`:
 
 ```console
-foo@bar:~$ ./main "**/*.hpp"
+foo@bar:~$ ./glob -r -i "**/*.hpp"
 "test/doctest.hpp"
 "include/foo/baz.hpp"
 "include/foo/foo.hpp"
@@ -140,7 +123,7 @@ foo@bar:~$ ./main "**/*.hpp"
 ### Match files in absolute pathnames
 
 ```console
-foo@bar:~$ ./main '/usr/local/include/nc*.h'
+foo@bar:~$ ./glob -i '/usr/local/include/nc*.h'
 "/usr/local/include/ncCheck.h"
 "/usr/local/include/ncGroupAtt.h"
 "/usr/local/include/ncUshort.h"
@@ -162,13 +145,13 @@ foo@bar:~$ ./main '/usr/local/include/nc*.h'
 foo@bar:~$ ls test_files_02
 1.txt 2.txt 3.txt 4.txt
 
-foo@bar:~$ ./main 'test_files_02/[0-9].txt'
+foo@bar:~$ ./glob -i 'test_files_02/[0-9].txt'
 "test_files_02/4.txt"
 "test_files_02/3.txt"
 "test_files_02/2.txt"
 "test_files_02/1.txt"
 
-foo@bar:~$ ./main 'test_files_02/[1-2]*'
+foo@bar:~$ ./glob -i 'test_files_02/[1-2]*'
 "test_files_02/2.txt"
 "test_files_02/1.txt"
 ```
@@ -177,7 +160,7 @@ foo@bar:~$ ./main 'test_files_02/[1-2]*'
 foo@bar:~$ ls test_files_03
 file1.txt file2.txt file3.txt file4.txt
 
-foo@bar:~$ ./main 'test_files_03/file[0-9].*'
+foo@bar:~$ ./glob -i 'test_files_03/file[0-9].*'
 "test_files_03/file2.txt"
 "test_files_03/file3.txt"
 "test_files_03/file1.txt"
@@ -190,14 +173,14 @@ foo@bar:~$ ./main 'test_files_03/file[0-9].*'
 foo@bar:~$ ls test_files_01
 __init__.py     bar.py      foo.py
 
-foo@bar:~$ ./main 'test_files_01/*[!__init__].py'
+foo@bar:~$ ./glob -i 'test_files_01/*[!__init__].py'
 "test_files_01/bar.py"
 "test_files_01/foo.py"
 
-foo@bar:~$ ./main 'test_files_01/*[!__init__][!bar].py'
+foo@bar:~$ ./glob -i 'test_files_01/*[!__init__][!bar].py'
 "test_files_01/foo.py"
 
-foo@bar:~$ ./main 'test_files_01/[!_]*.py'
+foo@bar:~$ ./glob -i 'test_files_01/[!_]*.py'
 "test_files_01/bar.py"
 "test_files_01/foo.py"
 ```
@@ -208,7 +191,7 @@ foo@bar:~$ ./main 'test_files_01/[!_]*.py'
 foo@bar:~$ ls test_files_02
 1.txt 2.txt 3.txt 4.txt
 
-foo@bar:~$ ./main 'test_files_02/?.txt'
+foo@bar:~$ ./glob -i 'test_files_02/?.txt'
 "test_files_02/4.txt"
 "test_files_02/3.txt"
 "test_files_02/2.txt"
@@ -219,7 +202,7 @@ foo@bar:~$ ./main 'test_files_02/?.txt'
 foo@bar:~$ ls test_files_03
 file1.txt file2.txt file3.txt file4.txt
 
-foo@bar:~$ ./main 'test_files_03/????[3-4].txt'
+foo@bar:~$ ./glob -i 'test_files_03/????[3-4].txt'
 "test_files_03/file3.txt"
 "test_files_03/file4.txt"
 ```
@@ -232,11 +215,17 @@ foo@bar:~$ ./main 'test_files_03/????[3-4].txt'
 foo@bar:~$ ls test_files_05
 file1.png file2.png file3.PNG file4.PNG
 
-foo@bar:~$ ./main 'test_files_05/*.png'
+foo@bar:~$ ./glob -i 'test_files_05/*.png'
 "test_files_05/file2.png"
 "test_files_05/file1.png"
 
-foo@bar:~$ ./main 'test_files_05/*.PNG'
+foo@bar:~$ ./glob -i 'test_files_05/*.PNG'
+"test_files_05/file3.PNG"
+"test_files_05/file4.PNG"
+
+foo@bar:~$ ./glob -i "test_files_05/*.png","test_files_05/*.PNG"
+"test_files_05/file2.png"
+"test_files_05/file1.png"
 "test_files_05/file3.PNG"
 "test_files_05/file4.PNG"
 ```

all/CMakeLists.txt

@@ -0,0 +1,8 @@
+# this script adds all subprojects to a single build to allow IDEs understand the full project
+# structure.
+
+cmake_minimum_required(VERSION 3.14 FATAL_ERROR)
+
+project(BuildAll LANGUAGES CXX)
+
+add_subdirectory(${CMAKE_CURRENT_LIST_DIR}/../standalone ${CMAKE_BINARY_DIR}/standalone)

clang-format.bash

@@ -0,0 +1,19 @@
+set(CPM_DOWNLOAD_VERSION 0.27.2)
+
+if(CPM_SOURCE_CACHE)
+  set(CPM_DOWNLOAD_LOCATION "${CPM_SOURCE_CACHE}/cpm/CPM_${CPM_DOWNLOAD_VERSION}.cmake")
+elseif(DEFINED ENV{CPM_SOURCE_CACHE})
+  set(CPM_DOWNLOAD_LOCATION "$ENV{CPM_SOURCE_CACHE}/cpm/CPM_${CPM_DOWNLOAD_VERSION}.cmake")
+else()
+  set(CPM_DOWNLOAD_LOCATION "${CMAKE_BINARY_DIR}/cmake/CPM_${CPM_DOWNLOAD_VERSION}.cmake")
+endif()
+
+if(NOT (EXISTS ${CPM_DOWNLOAD_LOCATION}))
+  message(STATUS "Downloading CPM.cmake to ${CPM_DOWNLOAD_LOCATION}")
+  file(DOWNLOAD
+       https://github.com/TheLartians/CPM.cmake/releases/download/v${CPM_DOWNLOAD_VERSION}/CPM.cmake
+       ${CPM_DOWNLOAD_LOCATION}
+  )
+endif()
+
+include(${CPM_DOWNLOAD_LOCATION})