_setup_util Namespace Reference

Functions
def	_get_workspaces
def	_parse_arguments
def	_prefix_env_variable
def	_rollback_env_variable
def	assignment
def	comment
def	find_env_hooks
def	prepend
def	prepend_env_variables
def	rollback_env_variables
Variables
tuple	args = _parse_arguments()
tuple	base_path = os.path.dirname(__file__)
string	CATKIN_MARKER_FILE = '.catkin'
string	CMAKE_PREFIX_PATH = '/home/robbie/homer/catkin_ws/devel;/opt/ros/hydro'
dictionary	ENV_VAR_SUBFOLDERS
tuple	environ = dict(os.environ)
tuple	IS_DARWIN = (system == 'Darwin')
tuple	IS_WINDOWS = (system == 'Windows')
list	lines = []
tuple	system = platform.system()

---

Function Documentation

def _setup_util._get_workspaces	(		environ,
			include_fuerte = False
	)		[private]

Based on CMAKE_PREFIX_PATH return all catkin workspaces.

:param include_fuerte: The flag if paths starting with '/opt/ros/fuerte' should be considered workspaces, ``bool``

Definition at line 110 of file _setup_util.py.

def _setup_util._parse_arguments

(

args = None

)

[private]

Definition at line 239 of file _setup_util.py.

def _setup_util._prefix_env_variable	(		environ,
			name,
			paths,
			subfolder
	)		[private]

Return the prefix to prepend to the environment variable NAME, adding any path in NEW_PATHS_STR without creating duplicate or empty items.

Definition at line 145 of file _setup_util.py.

def _setup_util._rollback_env_variable	(		environ,
			name,
			subfolder
	)		[private]

For each catkin workspace in CMAKE_PREFIX_PATH remove the first entry from env[NAME] matching workspace + subfolder.

:param subfolder: str '' or subfoldername that may start with '/'
:returns: the updated value of the environment variable.

Definition at line 80 of file _setup_util.py.

def _setup_util.assignment	(		key,
			value
	)

Definition at line 164 of file _setup_util.py.

def _setup_util.comment

(

msg

)

Definition at line 171 of file _setup_util.py.

def _setup_util.find_env_hooks	(		environ,
			cmake_prefix_path
	)

Generate shell code with found environment hooks
for the all workspaces.

Definition at line 187 of file _setup_util.py.

def _setup_util.prepend	(		environ,
			key,
			prefix
	)

Definition at line 178 of file _setup_util.py.

def _setup_util.prepend_env_variables	(		environ,
			env_var_subfolders,
			workspaces
	)

Generate shell code to prepend environment variables
for the all workspaces.

Definition at line 125 of file _setup_util.py.

def _setup_util.rollback_env_variables	(		environ,
			env_var_subfolders
	)

Generate shell code to reset environment variables
by unrolling modifications based on all workspaces in CMAKE_PREFIX_PATH.
This does not cover modifications performed by environment hooks.

Definition at line 61 of file _setup_util.py.

---

Variable Documentation

tuple _setup_util::args = _parse_arguments()

Definition at line 247 of file _setup_util.py.

tuple _setup_util::base_path = os.path.dirname(__file__)

Definition at line 255 of file _setup_util.py.

string _setup_util::CATKIN_MARKER_FILE = '.catkin'

Definition at line 44 of file _setup_util.py.

tuple _setup_util::CMAKE_PREFIX_PATH = '/home/robbie/homer/catkin_ws/devel;/opt/ros/hydro'

Definition at line 253 of file _setup_util.py.

dictionary _setup_util::ENV_VAR_SUBFOLDERS

Initial value:

{
    'CMAKE_PREFIX_PATH': '',
    'CPATH': 'include',
    'LD_LIBRARY_PATH' if not IS_DARWIN else 'DYLD_LIBRARY_PATH': 'lib',
    'PATH': 'bin',
    'PKG_CONFIG_PATH': 'lib/pkgconfig',
    'PYTHONPATH': 'lib/python2.7/dist-packages',
}

Definition at line 51 of file _setup_util.py.

tuple _setup_util::environ = dict(os.environ)

Definition at line 260 of file _setup_util.py.

tuple _setup_util::IS_DARWIN = (system == 'Darwin')

Definition at line 47 of file _setup_util.py.

tuple _setup_util::IS_WINDOWS = (system == 'Windows')

Definition at line 48 of file _setup_util.py.

list _setup_util::lines = []

Definition at line 261 of file _setup_util.py.

tuple _setup_util::system = platform.system()

Definition at line 46 of file _setup_util.py.