Public Member Functions | Public Attributes | List of all members
ros_introspection.cmake.CMake Class Reference

Public Member Functions

def __init__ (self, file_path=None, initial_contents=None, depth=0)
 
def __repr__ (self)
 
def add_command (self, cmd)
 
def enforce_ordering (self, default_style=None)
 
def get_clusters (self, desired_style)
 
def get_command_section (self, command_name, section_name)
 
def get_desired_style (self, default_style=None)
 
def get_executable_source (self)
 
def get_executables (self)
 
def get_insertion_index (self, cmd)
 
def get_libraries (self)
 
def get_library_source (self)
 
def get_ordered_build_targets (self)
 
def get_project_name (self)
 
def get_resolved_tokens (self, cmd, include_name=False)
 
def get_source_build_rules (self, tag, resolve_target_name=False)
 
def get_source_helper (self, tag)
 
def get_target_build_rules (self)
 
def get_test_section (self, create_if_needed=False)
 
def get_test_sections (self)
 
def get_test_source (self)
 
def is_metapackage (self)
 
def remove_all_commands (self, cmd_name)
 
def remove_command (self, cmd)
 
def resolve_variables (self, var)
 
def section_check (self, items, cmd_name, section_name='', zero_okay=False, alpha_order=True)
 
def upgrade_minimum_version (self, new_version)
 
def write (self, fn=None)
 

Public Attributes

 content_map
 
 contents
 
 depth
 
 existing_style
 
 file_path
 
 variables
 

Detailed Description

Definition at line 265 of file cmake.py.

Constructor & Destructor Documentation

◆ __init__()

def ros_introspection.cmake.CMake.__init__ (   self,
  file_path = None,
  initial_contents = None,
  depth = 0 
)

Definition at line 266 of file cmake.py.

Member Function Documentation

◆ __repr__()

def ros_introspection.cmake.CMake.__repr__ (   self)

Definition at line 550 of file cmake.py.

◆ add_command()

def ros_introspection.cmake.CMake.add_command (   self,
  cmd 
)

Definition at line 337 of file cmake.py.

◆ enforce_ordering()

def ros_introspection.cmake.CMake.enforce_ordering (   self,
  default_style = None 
)

Definition at line 531 of file cmake.py.

◆ get_clusters()

def ros_introspection.cmake.CMake.get_clusters (   self,
  desired_style 
)
Return a list of clusters where each cluster is an array of strings with a Command/CommandGroup at the end.

The clusters are sorted according to the desired style.
The strings are grouped at the beginning to maintain the newlines and indenting before each Command.

Definition at line 491 of file cmake.py.

◆ get_command_section()

def ros_introspection.cmake.CMake.get_command_section (   self,
  command_name,
  section_name 
)
Return the first command that matches the command name and has a matching section name.

If the section name is not found, return a command with the matching command name

Definition at line 458 of file cmake.py.

◆ get_desired_style()

def ros_introspection.cmake.CMake.get_desired_style (   self,
  default_style = None 
)
Determine which style to use, install_first or test_first.

If the default style is one of those two, use it

Definition at line 513 of file cmake.py.

◆ get_executable_source()

def ros_introspection.cmake.CMake.get_executable_source (   self)

Definition at line 395 of file cmake.py.

◆ get_executables()

def ros_introspection.cmake.CMake.get_executables (   self)

Definition at line 401 of file cmake.py.

◆ get_insertion_index()

def ros_introspection.cmake.CMake.get_insertion_index (   self,
  cmd 
)

Definition at line 320 of file cmake.py.

◆ get_libraries()

def ros_introspection.cmake.CMake.get_libraries (   self)

Definition at line 398 of file cmake.py.

◆ get_library_source()

def ros_introspection.cmake.CMake.get_library_source (   self)

Definition at line 392 of file cmake.py.

◆ get_ordered_build_targets()

def ros_introspection.cmake.CMake.get_ordered_build_targets (   self)

Definition at line 410 of file cmake.py.

◆ get_project_name()

def ros_introspection.cmake.CMake.get_project_name (   self)

Definition at line 288 of file cmake.py.

◆ get_resolved_tokens()

def ros_introspection.cmake.CMake.get_resolved_tokens (   self,
  cmd,
  include_name = False 
)

Definition at line 317 of file cmake.py.

◆ get_source_build_rules()

def ros_introspection.cmake.CMake.get_source_build_rules (   self,
  tag,
  resolve_target_name = False 
)

Definition at line 371 of file cmake.py.

◆ get_source_helper()

def ros_introspection.cmake.CMake.get_source_helper (   self,
  tag 
)

Definition at line 386 of file cmake.py.

◆ get_target_build_rules()

def ros_introspection.cmake.CMake.get_target_build_rules (   self)

Definition at line 404 of file cmake.py.

◆ get_test_section()

def ros_introspection.cmake.CMake.get_test_section (   self,
  create_if_needed = False 
)

Definition at line 439 of file cmake.py.

◆ get_test_sections()

def ros_introspection.cmake.CMake.get_test_sections (   self)

Definition at line 425 of file cmake.py.

◆ get_test_source()

def ros_introspection.cmake.CMake.get_test_source (   self)

Definition at line 432 of file cmake.py.

◆ is_metapackage()

def ros_introspection.cmake.CMake.is_metapackage (   self)

Definition at line 368 of file cmake.py.

◆ remove_all_commands()

def ros_introspection.cmake.CMake.remove_all_commands (   self,
  cmd_name 
)

Definition at line 363 of file cmake.py.

◆ remove_command()

def ros_introspection.cmake.CMake.remove_command (   self,
  cmd 
)

Definition at line 358 of file cmake.py.

◆ resolve_variables()

def ros_introspection.cmake.CMake.resolve_variables (   self,
  var 
)

Definition at line 295 of file cmake.py.

◆ section_check()

def ros_introspection.cmake.CMake.section_check (   self,
  items,
  cmd_name,
  section_name = '',
  zero_okay = False,
  alpha_order = True 
)
Ensure there's a CMake command of the given type with the given section name and items.

Definition at line 471 of file cmake.py.

◆ upgrade_minimum_version()

def ros_introspection.cmake.CMake.upgrade_minimum_version (   self,
  new_version 
)
Upgrade the CMake version to the new version (specified as a tuple).

Definition at line 541 of file cmake.py.

◆ write()

def ros_introspection.cmake.CMake.write (   self,
  fn = None 
)

Definition at line 553 of file cmake.py.

Member Data Documentation

◆ content_map

ros_introspection.cmake.CMake.content_map

Definition at line 272 of file cmake.py.

◆ contents

ros_introspection.cmake.CMake.contents

Definition at line 269 of file cmake.py.

◆ depth

ros_introspection.cmake.CMake.depth

Definition at line 278 of file cmake.py.

◆ existing_style

ros_introspection.cmake.CMake.existing_style

Definition at line 286 of file cmake.py.

◆ file_path

ros_introspection.cmake.CMake.file_path

Definition at line 267 of file cmake.py.

◆ variables

ros_introspection.cmake.CMake.variables

Definition at line 280 of file cmake.py.


The documentation for this class was generated from the following file:


ros_introspection
Author(s):
autogenerated on Tue Jun 21 2022 03:01:38