Getting Started

This part provides some helpful information for users who want to get started using CMakePPLang. If you are unfamiliar with the CMake language, it is best to start by learning the basics of the CMake language (CMake introduction, CMake development tutorial). If you are already familiar with the CMake language, start by Automatically Downloading and Including CMakePPLang and then move on to CMakePPLang Examples to learn the basics of using CMakePPLang.

• Obtaining CMakePPLang
  • Automatically Downloading and Including CMakePPLang
    • Pinning a CMakePPLang Version
  • Downloading CMakePPLang and Building Manually
• CMakePPLang Examples
  • 1. Using Classes
    • 1.1. Writing a Basic Class
    • 1.2. Adding a Member Function
    • 1.3. Adding a Function That Takes an Argument
    • 1.4. Adding a Function That References Attributes
    • 1.5. Returning a Value from a Function
    • 1.6. Adding Multiple Return Points to a Function
    • 1.7. Overloading a Function
    • 1.8. Adding a User-Defined Constructor
    • 1.9. Using the KWARGS Constructor
    • 1.10. Writing a Derived Class
    • 1.11. Inheriting from Multiple Classes
    • 1.12. Adding A Pure Virtual Member Function
  • 2. Using Utilities
    • 2.1. Checking if Variables are Equal
    • 2.2. Serializing a Variable
    • 2.3. Copying a Variable
    • 2.4. Checking if Variable Contains a Value
    • 2.5. Determining the Type of a Variable
    • 2.6. Check for Conflict with a Built-in Type
    • 2.7. Returning a Value
    • 2.8. Asserting a Condition
    • 2.9. Checking if a Directory Exists
    • 2.10. Checking if a File Exists
    • 2.11. Manipulating Globals
    • 2.12. Creating a Unique Identifier
• Example Project using CMakePPLang
  • Project Layout
  • Initial CMake Boilerplate
  • Fetching CMakePPLang
  • Defining the Class
  • Testing the Class
  • Building the Project
  • Running the Tests