roscompile.installs Namespace Reference

Functions
def	check_complex_section (cmd, key, value)
def	fix_double_directory_installs (package)
def	get_commands_by_type (cmake, name, subfolder='')
def	get_install_type (destination)
def	get_install_types (cmd, subfolder='')
def	get_multiword_section (cmd, words)
def	install_section_check (cmake, items, install_type, directory=False, subfolder='')
def	install_sections (cmd, destination_map, subfolder='')
def	matches_patterns (item, patterns)
def	remove_install_section (cmd, destination_map)
def	update_cplusplus_installs (package)
def	update_misc_installs (package)

Variables
list	FILES_TO_NOT_INSTALL = ['CHANGELOG.rst', 'README.md', '.travis.yml', 'bitbucket-pipelines.yml']
dictionary	INSTALL_CONFIGS

Function Documentation

def roscompile.installs.check_complex_section	(		cmd,
			key,
			value
	)

Find the section matching the key and ensure the value is in it.

Key could be multiple words, see get_multiword_section.
If the appopriate section is not found, it adds it.

Definition at line 82 of file installs.py.

def roscompile.installs.fix_double_directory_installs

(

package

)

Definition at line 219 of file installs.py.

def roscompile.installs.get_commands_by_type	(		cmake,
			name,
			subfolder = ''
	)

Definition at line 137 of file installs.py.

def roscompile.installs.get_install_type

(

destination

)

For a given catkin destination, return the matching install type.

Definition at line 24 of file installs.py.

def roscompile.installs.get_install_types	(		cmd,
			subfolder = ''
	)

For a given CMake command, determine the install type(s) that this command uses.

If there is a non-empty subfolder, we only return the install types if the command
installs into the catkin_destination with the given subfolder

Definition at line 31 of file installs.py.

def roscompile.installs.get_multiword_section	(		cmd,
			words
	)

Find a section that matches the last word, assuming all the previous sections matched the other words.

Our definition of a CMake command section is ONE all-caps word followed by tokens.
Installing stuff requires these weird TWO word sections (i.e. ARCHIVE DESTINATION).

Ergo, we need to find the section that matches the second word, presuming the section
before matched the first word.

Definition at line 50 of file installs.py.

def roscompile.installs.install_section_check	(		cmake,
			items,
			install_type,
			directory = False,
			subfolder = ''
	)

Definition at line 145 of file installs.py.

def roscompile.installs.install_sections	(		cmd,
			destination_map,
			subfolder = ''
	)

Ensure that the command has all the appropriate CMake sections with the matching catkin destinations.

If the subfolder is defined, the subfolder is appended to the catkin destination.

Definition at line 102 of file installs.py.

def roscompile.installs.matches_patterns	(		item,
			patterns
	)

Definition at line 74 of file installs.py.

def roscompile.installs.remove_install_section	(		cmd,
			destination_map
	)

Definition at line 114 of file installs.py.

def roscompile.installs.update_cplusplus_installs

(

package

)

Definition at line 196 of file installs.py.

def roscompile.installs.update_misc_installs

(

package

)

Definition at line 204 of file installs.py.

Variable Documentation

list roscompile.installs.FILES_TO_NOT_INSTALL = ['CHANGELOG.rst', 'README.md', '.travis.yml', 'bitbucket-pipelines.yml']

Definition at line 10 of file installs.py.

dictionary roscompile.installs.INSTALL_CONFIGS

Initial value:

= {
    'exec': ('TARGETS', {'${CATKIN_PACKAGE_BIN_DESTINATION}': ['RUNTIME DESTINATION']}),
    'library': ('TARGETS', {'${CATKIN_PACKAGE_LIB_DESTINATION}': ['ARCHIVE DESTINATION', 'LIBRARY DESTINATION'],
                            '${CATKIN_GLOBAL_BIN_DESTINATION}': ['RUNTIME DESTINATION']}),
    'headers': ('FILES', {'${CATKIN_PACKAGE_INCLUDE_DESTINATION}': ['DESTINATION']}),
    'misc': ('FILES', {'${CATKIN_PACKAGE_SHARE_DESTINATION}': ['DESTINATION']})
}

Definition at line 15 of file installs.py.