isolate

Documentation

Overview

Package isolate implements the code to process '.isolate' files to generate '.isolated' files.

Index

• Constants
• func IsValidVariable(variable string) bool
• func LoadIsolateForConfig(isolateDir string, content []byte, configVariables map[string]string) ([]string, string, error)
• func ProcessIsolate(opts *ArchiveOptions) ([]string, string, error)
• func ReplaceVariables(str string, opts *ArchiveOptions) (string, error)
• type ArchiveOptions
  • func (a *ArchiveOptions) Init()
  • func (a *ArchiveOptions) PostProcess(cwd string)
• type ConfigSettings
• type Configs
  • func LoadIsolateAsConfig(isolateDir string, content []byte) (*Configs, error)
  • func (c *Configs) GetConfig(cn configName) (*ConfigSettings, error)

Constants

const IsolatedGenJSONVersion = 1

IsolatedGenJSONVersion is used in the batcharchive json format.

TODO(tandrii): Migrate to batch_archive.go.

const ValidVariable = "[A-Za-z_][A-Za-z_0-9]*"

ValidVariable is the regexp of valid isolate variable name.

Functions

func IsValidVariable

func IsValidVariable(variable string) bool

IsValidVariable returns true if the variable is a valid symbol name.

func LoadIsolateForConfig

func LoadIsolateForConfig(isolateDir string, content []byte, configVariables map[string]string) (
	[]string, string, error)

LoadIsolateForConfig loads the .isolate file and returns the information unprocessed but filtered for the specific OS.

Returns:

dependencies, relDir, error.

relDir and dependencies are fixed to use os.PathSeparator.

func ProcessIsolate

func ProcessIsolate(opts *ArchiveOptions) ([]string, string, error)

ProcessIsolate parses an isolate file, returning the list of dependencies

func ReplaceVariables

func ReplaceVariables(str string, opts *ArchiveOptions) (string, error)

ReplaceVariables replaces any occurrences of '<(FOO)' in 'str' with the corresponding variable from 'opts'.

If any substitution refers to a variable that is missing, the returned error will refer to the first such variable. In the case of errors, the returned string will still contain a valid result for any non-missing substitutions.

Types

type ArchiveOptions

type ArchiveOptions struct {
	Isolate             string              `json:"isolate"`
	IgnoredPathFilterRe string              `json:"ignored_path_filter_re"`
	PathVariables       stringmapflag.Value `json:"path_variables"`
	ConfigVariables     stringmapflag.Value `json:"config_variables"`
	AllowMissingFileDir bool                `json:"allow_missing_file_dir"`
}

ArchiveOptions for archiving trees.

func (*ArchiveOptions) Init

func (a *ArchiveOptions) Init()

Init initializes with non-nil values.

func (*ArchiveOptions) PostProcess

func (a *ArchiveOptions) PostProcess(cwd string)

PostProcess post-processes the flags to fix any compatibility issue.

type ConfigSettings

type ConfigSettings struct {
	// Files is the list of dependencies. The items use '/' as a path separator.
	Files []string
	// IsolateDir is the path where to start the command from.
	// It uses the OS' native path separator and it must be an absolute path.
	IsolateDir string
}

ConfigSettings represents the dependency variables for a single build configuration.

The structure is immutable.

type Configs

type Configs struct {
	// ConfigVariables contains names only, sorted by name; the order is same as in byConfig.
	ConfigVariables []string
	// contains filtered or unexported fields
}

Configs represents a processed .isolate file.

Stores the file in a processed way, split by configuration.

At this point, we don't know all the possibilities. So mount a partial view that we have.

This class doesn't hold isolateDir, since it is dependent on the final configuration selected.

func LoadIsolateAsConfig

func LoadIsolateAsConfig(isolateDir string, content []byte) (*Configs, error)

LoadIsolateAsConfig parses one .isolate file and returns a Configs instance.

Arguments:
  isolateDir: only used to load relative includes so it doesn't depend on
              cwd.
  value: is the loaded dictionary that was defined in the gyp file.

The expected format is strict, anything diverting from the format below will
result in error:
{
  'includes': [
    'foo.isolate',
  ],
  'conditions': [
    ['OS=="vms" and foo=42', {
      'variables': {
        'files': [
          ...
        ],
      },
    }],
    ...
  ],
  'variables': {
    ...
  },
}

func (*Configs) GetConfig

func (c *Configs) GetConfig(cn configName) (*ConfigSettings, error)

GetConfig returns all configs that matches this config as a single ConfigSettings.

Returns nil if none apply.