SCons.Node.FS.RootDir

Package SCons :: Package Node :: Module FS :: Class RootDir

[show private | hide private]

Class RootDir

Node --+        
       |        
    Base --+    
           |    
         Dir --+
               |
              RootDir

A class for the root directory of a file system.

This is the same as a Dir class, except that the path separator ('/' or '') is actually part of the name, so we don't need to add a separator when creating the path names of entries within this directory.

Method Summary
	`__init__(self, name, fs)`
	`__str__(self)` A Node.FS.Base object's string representation is its path name.
	`entry_abspath(self, name)`
	`entry_labspath(self, name)`
	`entry_path(self, name)`
	`entry_tpath(self, name)`
	`get_dir(self)`
	`is_under(self, dir)`
	`must_be_same(self, klass)` This node, which already existed, is being looked up as the specified klass.
	`src_builder(self)` Fetch the source code builder for this node.
	`up(self)`
	`_lookup_abs(self, p, klass, create)` Fast (?) lookup of a normalized absolute path.
Inherited from Dir
	`addRepository(self, dir)`
	`alter_targets(self)` Return any corresponding targets in a build directory.
	`build(self, **kw)` A null "builder" for directories.
	`changed_since_last_build(self, target, prev_ni)`
	`Dir(self, name, create)` Looks up or creates a directory node named 'name' relative to this directory.
	`dir_on_disk(self, name)`
	`diskcheck_match(self)`
	`do_duplicate(self, src)`
	`Entry(self, name)` Looks up or creates an entry node named 'name' relative to this directory.
	`entry_exists_on_disk(self, name)`
	`File(self, name)` Looks up or creates a file node named 'name' relative to this directory.
	`file_on_disk(self, name)`
	`get_all_rdirs(self)`
	`get_contents(self)` Return aggregate contents of all our children.
	`get_env_scanner(self, env, kw)`
	`get_found_includes(self, env, scanner, path)` Return this directory's implicit dependencies.
	`get_target_scanner(self)`
	`get_timestamp(self)` Return the latest timestamp from among our children
	`getRepositories(self)` Returns a list of repositories for this directory.
	`glob(self, pathname, ondisk, source, strings)` Returns a list of Nodes (or strings) matching a specified pathname pattern.
	`is_up_to_date(self)` If any child is not up-to-date, then this directory isn't, either.
	`link(self, srcdir, duplicate)` Set this directory as the build directory for the supplied source directory.
	`multiple_side_effect_has_builder(self)` Return whether this Node has a builder or not.
	`prepare(self)` Prepare for this Node to be built.
	`rdir(self)`
	`rel_path(self, other)` Return a path to "other" relative to this directory.
	`scanner_key(self)` A directory does not get scanned.
	`sconsign(self)` Return the .sconsign file info for this directory, creating it first if necessary.
	`srcdir_duplicate(self, name)`
	`srcdir_find_file(self, filename)`
	`srcdir_list(self)`
	`srcnode(self)` Dir has a special need for srcnode()...if we have a srcdir attribute set, then that is our srcnode.
	`walk(self, func, arg)` Walk this directory tree by calling the specified function for each directory in the tree.
	`_create(self)` Create this directory, silently and without worrying about whether the builder is the default or not.
	`_glob1(self, pattern, ondisk, source, strings)` Globs for and returns a list of entry names matching a single pattern in this directory.
	`_lookup_rel(self, name, klass, create)` Looks up a normalized relative path name, relative to this directory.
	`_morph(self)` Turn a file system Node (either a freshly initialized directory object or a separate Entry object) into a proper directory object.
	`_rel_path_key(self, other)`
	`_srcdir_find_file_key(self, filename)`
Inherited from Base
	`exists(self)` Does this node exists?
	`for_signature(self)` Return a string representation of the Node that will always be the same for this particular Node, no matter what.
	`get_abspath(self)` Get the absolute path of the file.
	`get_path(self, dir)` Return path relative to the current working directory of the Node.FS.Base object that owns us.
	`get_subst_proxy(self)` This method is expected to return an object that will function exactly like this Node, except that it implements any additional special features that we would like to be in effect for Environment variable substitution.
	`get_suffix(self)`
	`getmtime(self)`
	`getsize(self)`
	`isdir(self)`
	`isfile(self)`
	`islink(self)`
	`RDirs(self, pathlist)` Search for a list of directories in the Repository list.
	`rentry(self)`
	`rexists(self)` Does this node exist locally or in a repositiory?
	`rfile(self)`
	`Rfindalldirs(self, pathlist)` Return all of the directories for a given path list, including corresponding "backing" directories in any repositories.
	`rstr(self)` A Node.FS.Base object's string representation is its path name.
	`set_local(self)`
	`set_src_builder(self, builder)` Set the source code builder for this node.
	`stat(self)`
	`target_from_source(self, prefix, suffix, splitext)` Generates a target entry that corresponds to this entry (usually a source file) with the specified prefix and suffix.
	`_get_str(self)`
	`_Rfindalldirs_key(self, pathlist)`
	`_save_str(self)`
Inherited from Node
	`add_dependency(self, depend)` Adds dependencies.
	`add_ignore(self, depend)` Adds dependencies to ignore.
	`add_prerequisite(self, prerequisite)` Adds prerequisites
	`add_source(self, source)` Adds sources.
	`add_to_implicit(self, deps)`
	`add_to_waiting_parents(self, node)` Returns the number of nodes added to our waiting parents list: 1 if we add a unique waiting parent, 0 if not.
	`add_to_waiting_s_e(self, node)`
	`add_wkid(self, wkid)` Add a node to the list of kids waiting to be evaluated
	`all_children(self, scan)` Return a list of all the node's direct children.
	`builder_set(self, builder)`
	`built(self)` Called just after this node is successfully built.
	`call_for_all_waiting_parents(self, func)`
	`changed(self, node)` Returns if the node is up-to-date with respect to the BuildInfo stored last time it was built.
	`children(self, scan)` Return a list of the node's direct children, minus those that are ignored by this node.
	`children_are_up_to_date(self)` Alternate check for whether the Node is current: If all of our children were up-to-date, then this Node was up-to-date, too.
	`clear(self)` Completely clear a Node of all its cached state (so that it can be re-evaluated by interfaces that do continuous integration builds).
	`clear_memoized_values(self)`
	`Decider(self, function)`
	`del_binfo(self)` Delete the build info from this node.
	`disambiguate(self, must_exist)`
	`do_not_ignore(self, node)`
	`do_not_store_info(self)`
	`env_set(self, env, safe)`
	`executor_cleanup(self)` Let the executor clean up any cached information.
	`explain(self)`
	`get_binfo(self)` Fetch a node's build information.
	`get_build_env(self)` Fetch the appropriate Environment to build this node.
	`get_build_scanner_path(self, scanner)` Fetch the appropriate scanner path for this node.
	`get_builder(self, default_builder)` Return the set builder, or a specified default value
	`get_cachedir_csig(self)`
	`get_csig(self)`
	`get_env(self)`
	`get_executor(self, create)` Fetch the action executor for this node.
	`get_implicit_deps(self, env, scanner, path)` Return a list of implicit dependencies for this node.
	`get_ninfo(self)`
	`get_source_scanner(self, node)` Fetch the source scanner for the specified node
	`get_state(self)`
	`get_stored_implicit(self)` Fetch the stored implicit dependencies
	`get_stored_info(self)`
	`get_string(self, for_signature)` This is a convenience function designed primarily to be used in command generators (i.e., CommandGeneratorActions or Environment variables that are callable), which are called with a for_signature argument that is nonzero if the command generator is being called to generate a signature for the command line, which determines if we should rebuild or not.
	`has_builder(self)` Return whether this Node has a builder or not.
	`has_explicit_builder(self)` Return whether this Node has an explicit builder
	`is_derived(self)` Returns true iff this node is derived (i.e.
	`is_literal(self)` Always pass the string representation of a Node to the command interpreter literally.
	`make_ready(self)` Get a Node ready for evaluation.
	`missing(self)`
	`new_binfo(self)`
	`new_ninfo(self)`
	`postprocess(self)` Clean up anything we don't need to hang onto after we've been built.
	`remove(self)` Remove this Node: no-op by default.
	`render_include_tree(self)` Return a text representation, suitable for displaying to the user, of the include tree for the sources of this node.
	`reset_executor(self)` Remove cached executor; forces recompute when needed.
	`retrieve_from_cache(self)` Try to retrieve the node's content from a cache
	`scan(self)` Scan this node's dependents for implicit dependencies.
	`select_scanner(self, scanner)` Selects a scanner for this Node.
	`set_always_build(self, always_build)` Set the Node's always_build value.
	`set_executor(self, executor)` Set the action executor for this node.
	`set_explicit(self, is_explicit)`
	`set_nocache(self, nocache)` Set the Node's nocache value.
	`set_noclean(self, noclean)` Set the Node's noclean value.
	`set_precious(self, precious)` Set the Node's precious value.
	`set_state(self, state)`
	`state_has_changed(self, target, prev_ni)`
	`store_info(self)` Make the build signature permanent (that is, store it in the .sconsign file or equivalent).
	`visited(self)` Called just after this node has been visited (with or without a build).
	`_add_child(self, collection, dict, child)` Adds 'child' to 'collection', first checking 'dict' to see if it's already present.
	`_all_children_get(self)`
	`_children_get(self)`
	`_children_reset(self)`

Class Variable Summary
Inherited from Dir
`list`	`memoizer_counters` = `[<SCons.Memoize.CountValue instance ...`

Method Details

str(self)
(Informal representation operator)

A Node.FS.Base object's string representation is its path name.

Overrides:: SCons.Node.FS.Base.__str__ (inherited documentation)

must_be_same(self, klass)

This node, which already existed, is being looked up as the specified klass. Raise an exception if it isn't.

Overrides:: SCons.Node.FS.Base.must_be_same (inherited documentation)

src_builder(self)

Fetch the source code builder for this node.

If there isn't one, we cache the source code builder specified for the directory (which in turn will cache the value from its parent directory, and so on up to the file system root).

Overrides:: SCons.Node.FS.Base.src_builder (inherited documentation)

_lookup_abs(self, p, klass, create=1)

Fast (?) lookup of a normalized absolute path.

This method is intended for use by internal lookups with already-normalized path data. For general-purpose lookups, use the FS.Entry(), FS.Dir() or FS.File() methods.

The caller is responsible for making sure we're passed a normalized absolute path; we merely let Python's dictionary look up and return the One True Node.FS object for the path.

If no Node for the specified "p" doesn't already exist, and "create" is specified, the Node may be created after recursive invocation to find or create the parent directory or directories.

Generated by Epydoc 2.1 on Wed Dec 12 09:39:31 2007

http://epydoc.sf.net

Class RootDir

__str__(self) (Informal representation operator)

must_be_same(self, klass)

src_builder(self)

_lookup_abs(self, p, klass, create=1)

str(self)
(Informal representation operator)