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

Class 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.

Nested Classes

[hide private]

Inherited from Dir: BuildInfo, NodeInfo

Inherited from Node: Attrs

Instance Methods

[hide private]

__init__(self, name, fs)
Initialize a generic Node.FS.Base object.

source code

must_be_same(self, klass)
This node, which already existed, is being looked up as the specified klass.

source code

_lookup_abs(self, p, klass, create=1)
Fast (?) lookup of a *normalized* absolute path.

source code

__str__(self)
A Node.FS.Base object's string representation is its path name.

source code

entry_abspath(self, name)

source code

entry_labspath(self, name)

source code

entry_path(self, name)

source code

entry_tpath(self, name)

source code

is_under(self, dir)

source code

up(self)

source code

get_dir(self)

source code

src_builder(self)
Fetch the source code builder for this node.

source code

Inherited from Dir: Dir, Entry, File, addRepository, alter_targets, build, changed_since_last_build, dir_on_disk, diskcheck_match, do_duplicate, entry_exists_on_disk, file_on_disk, getRepositories, get_all_rdirs, get_contents, get_csig, get_env_scanner, get_found_includes, get_target_scanner, get_text_contents, get_timestamp, glob, is_up_to_date, link, multiple_side_effect_has_builder, prepare, rdir, rel_path, scanner_key, sconsign, srcdir_duplicate, srcdir_find_file, srcdir_list, srcnode, walk

Inherited from Dir (private): _create, _glob1, _lookup_rel, _morph, _rel_path_key, _srcdir_find_file_key

Inherited from Base: RDirs, Rfindalldirs, exists, for_signature, get_abspath, get_path, get_subst_proxy, get_suffix, getmtime, getsize, isdir, isfile, islink, rentry, rexists, rfile, rstr, set_local, set_src_builder, stat, str_for_display, target_from_source

Inherited from Base (private): _Rfindalldirs_key, _get_str, _save_str

Inherited from Node: Decider, add_dependency, add_ignore, add_prerequisite, add_source, add_to_implicit, add_to_waiting_parents, add_to_waiting_s_e, add_wkid, all_children, builder_set, built, changed, children, children_are_up_to_date, clear, clear_memoized_values, del_binfo, disambiguate, do_not_store_info, env_set, executor_cleanup, explain, get_binfo, get_build_env, get_build_scanner_path, get_builder, get_cachedir_csig, get_env, get_executor, get_implicit_deps, get_ninfo, get_source_scanner, get_state, get_stored_implicit, get_stored_info, get_string, has_builder, has_explicit_builder, is_derived, is_literal, make_ready, missing, new_binfo, new_ninfo, postprocess, push_to_cache, remove, render_include_tree, reset_executor, retrieve_from_cache, scan, select_scanner, set_always_build, set_executor, set_explicit, set_nocache, set_noclean, set_precious, set_specific_source, set_state, state_has_changed, store_info, visited

Inherited from Node (private): _add_child, _children_get, _children_reset

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__

Class Variables

[hide private]

Inherited from Dir: memoizer_counters

Inherited from Node: __metaclass__

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

init(self, name, fs)
(Constructor)

source code

Initialize a generic Node.FS.Base object.

Call the superclass initialization, take care of setting up
our relative and absolute paths, identify our parent
directory, and indicate that this node should use
signatures.

Overrides: Dir.__init__

must_be_same(self, klass)

source code


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

Overrides: Base.must_be_same: (inherited documentation)

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

source code


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.

str(self)
(Informal representation operator)

source code

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

Overrides: Base.__str__: (inherited documentation)

Overrides: Dir.up

get_dir(self)

source code

Overrides: Base.get_dir

src_builder(self)

source code

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: Base.src_builder: (inherited documentation)

Class RootDir

__init__(self, name, fs) (Constructor)

must_be_same(self, klass)

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

__str__(self) (Informal representation operator)

entry_abspath(self, name)

entry_labspath(self, name)

entry_path(self, name)

entry_tpath(self, name)

is_under(self, dir)

up(self)

get_dir(self)

src_builder(self)

init(self, name, fs)
(Constructor)

str(self)
(Informal representation operator)