TopologicalSort.cmake File Reference

CMake implementation of topological sorting algorithm. More...

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
function	topological_sort (in LIST, in PREFIX, in SUFFIX)

---

Detailed Description

CMake implementation of topological sorting algorithm.

Perform a reverse topological sort on the given LIST.

topological_sort(my_list "MY_" "_EDGES")

LIST is the name of a variable containing a list of elements to be sorted in reverse topological order. Each element in the list has a set of outgoing edges (for example, those other list elements that it depends on). In the resulting reverse topological ordering (written back into the variable named LIST), an element will come later in the list than any of the elements that can be reached by following its outgoing edges and the outgoing edges of any vertices they target, recursively. Thus, if the edges represent dependencies on build targets, for example, the reverse topological ordering is the order in which one would build those targets.

For each element E in this list, the edges for E are contained in the variable named ${PREFIX}${E}${SUFFIX}. If no such variable exists, then it is assumed that there are no edges. For example, if my_list contains a, b, and c, one could provide a dependency graph using the following variables:

MY_A_EDGES b MY_B_EDGES MY_C_EDGES a b

With the involcation of topological_sort shown above and these variables, the resulting reverse topological ordering will be b, a, c.

///
/// Modified from Boost Utilities
///
/// Copyright 2010 Kitware, Inc.
///
/// Copyright 2007 Douglas Gregor <doug.gregor@gmail.com>
/// Copyright 2007 Troy Straszheim
///
/// Distributed under the Boost Software License, Version 1.0.
///
/// Boost Software License - Version 1.0 - August 17th, 2003
///
/// Permission is hereby granted, free of charge, to any person or organization
/// obtaining a copy of the software and accompanying documentation covered by
/// this license (the "Software") to use, reproduce, display, distribute,
/// execute, and transmit the Software, and to prepare derivative works of the
/// Software, and to permit third-parties to whom the Software is furnished to
/// do so, all subject to the following:
///
/// The copyright notices in the Software and this entire statement, including
/// the above license grant, this restriction and the following disclaimer,
/// must be included in all copies of the Software, in whole or in part, and
/// all derivative works of the Software, unless such copies or derivative
/// works are solely in the form of machine-executable object code generated by
/// a source language processor.
///
/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
/// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
/// FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
/// SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
/// FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
/// ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
/// DEALINGS IN THE SOFTWARE.
///
/// 

Definition in file TopologicalSort.cmake.

---

Function Documentation

function topological_sort	(	in	LIST,
		in	PREFIX,
		in	SUFFIX
	)

Returns:

Nothing.