DartdocOption<T extends Object?> abstract

abstract class DartdocOption<T extends Object?>

An abstract class for interacting with dartdoc options.

This class and its implementations allow Dartdoc to declare options that are both defined in a configuration file and specified via the command line, with searching the directory tree for a proper file and overriding file options with the command line built-in. A number of sanity checks are also built in to these classes so that file existence can be verified, types constrained, and defaults provided.

This class caches the current working directory from the ResourceProvider; do not attempt to change it during the life of an instance.

Use via implementations DartdocOptionSet, DartdocOptionArgFile, DartdocOptionArgOnly, and DartdocOptionFileOnly.

Implementers

• DartdocOptionArgFile<T>
• DartdocOptionArgOnly<T>
• DartdocOptionArgSynth<T>
• DartdocOptionFileOnly<T>
• DartdocOptionFileSynth<T>
• DartdocOptionSet
• DartdocOptionSyntheticOnly<T>
• DartdocSyntheticOption<T>

Constructors

DartdocOption()

DartdocOption(
  String name,
  T? defaultsTo,
  String help,
  OptionKind optionIs,
  bool mustExist,
  (T Function(YamlMap, String, ResourceProvider))? _convertYamlToType,
  ResourceProvider resourceProvider,
)

Implementation

DartdocOption(this.name, this.defaultsTo, this.help, this.optionIs,
    this.mustExist, this._convertYamlToType, this.resourceProvider) {
  if (isDir || isFile || isGlob) {
    assert(_isString || _isListString || _isMapString);
  }
  if (mustExist) {
    // Globs by definition don't have to exist.
    assert(isDir || isFile);
  }
}

Properties

defaultsTo final

final T? defaultsTo

This is the value returned if we couldn't find one otherwise.

Implementation

final T? defaultsTo;

hashCode no setter inherited

int get hashCode

The hash code for this object.

A hash code is a single integer which represents the state of the object that affects operator == comparisons.

All objects have hash codes. The default hash code implemented by Object represents only the identity of the object, the same way as the default operator == implementation only considers objects equal if they are identical (see identityHashCode).

If operator == is overridden to use the object state instead, the hash code must also be changed to represent that state, otherwise the object cannot be used in hash based data structures like the default Set and Map implementations.

Hash codes must be the same for objects that are equal to each other according to operator ==. The hash code of an object should only change if the object changes in a way that affects equality. There are no further requirements for the hash codes. They need not be consistent between executions of the same program and there are no distribution guarantees.

Objects that are not equal are allowed to have the same hash code. It is even technically allowed that all instances have the same hash code, but if clashes happen too often, it may reduce the efficiency of hash-based data structures like HashSet or HashMap.

If a subclass overrides hashCode, it should override the operator == operator as well to maintain consistency.

Inherited from Object.

Implementation

external int get hashCode;

help final

final String help

Text string for help passed on in command line options.

Implementation

final String help;

isDir no setter

bool get isDir

Set to true if this option represents the name of a directory.

Implementation

bool get isDir => optionIs == OptionKind.dir;

isFile no setter

bool get isFile

Set to true if this option represents the name of a file.

Implementation

bool get isFile => optionIs == OptionKind.file;

isGlob no setter

bool get isGlob

Set to true if this option represents a glob.

Implementation

bool get isGlob => optionIs == OptionKind.glob;

keys no setter

Iterable<String> get keys

All object names starting at the root.

Implementation

Iterable<String> get keys {
  var keyList = <String>[];
  DartdocOption<dynamic> option = this;
  while (option is! DartdocOptionRoot) {
    keyList.add(option.name);
    option = option.parent;
  }
  keyList.add(option.name);
  return keyList.reversed;
}

mustExist final

final bool mustExist

Set to true if DartdocOption subclasses should validate that the directory or file exists. Does not imply validation of defaultsTo, and requires that one of isDir or isFile is set.

Implementation

final bool mustExist;

name final

final String name

The name of this option, not including the names of any parents.

Implementation

final String name;

optionIs final

final OptionKind optionIs

Implementation

final OptionKind optionIs;

parent late final

final late DartdocOption<dynamic> parent

getter:

To avoid accessing early, call add on the option's parent before looking up unless this is a DartdocOptionRoot.

setter:

To avoid accessing early, call add on the option's parent before looking up unless this is a DartdocOptionRoot.

Implementation

late final DartdocOption<dynamic> parent;

resourceProvider final

final ResourceProvider resourceProvider

Implementation

final ResourceProvider resourceProvider;

root no setter

DartdocOptionRoot get root

The DartdocOptionRoot containing this object.

Implementation

DartdocOptionRoot get root {
  DartdocOption<dynamic> p = this;
  while (p is! DartdocOptionRoot) {
    p = p.parent;
  }
  return p;
}

runtimeType no setter inherited

Type get runtimeType

A representation of the runtime type of the object.

Inherited from Object.

Implementation

external Type get runtimeType;

Methods

add()

void add(DartdocOption<Object?> option)

Adds a DartdocOption to the children of this DartdocOption.

Implementation

void add(DartdocOption option) {
  if (_children.containsKey(option.name)) {
    throw DartdocOptionError(
        'Tried to add two children with the same name: ${option.name}');
  }
  _children[option.name] = option;
  // TODO(jcollins-g): Consider a stronger refactor that doesn't rely on
  // post-construction setup for [parent].
  option.parent = this;
}

addAll()

void addAll(Iterable<DartdocOption<Object?>> options)

Adds a list of dartdoc options to the children of this DartdocOption.

Implementation

void addAll(Iterable<DartdocOption> options) => options.forEach(add);

getValueAs()

U getValueAs<U>(String name, Folder dir)

Get the immediate child of this node named name and its value at dir.

Implementation

U getValueAs<U>(String name, Folder dir) =>
    _children[name]?.valueAt(dir) as U;

noSuchMethod() inherited

dynamic noSuchMethod(Invocation invocation)

Invoked when a nonexistent method or property is accessed.

A dynamic member invocation can attempt to call a member which doesn't exist on the receiving object. Example:

dynamic object = 1;
object.add(42); // Statically allowed, run-time error

This invalid code will invoke the noSuchMethod method of the integer 1 with an Invocation representing the .add(42) call and arguments (which then throws).

Classes can override noSuchMethod to provide custom behavior for such invalid dynamic invocations.

A class with a non-default noSuchMethod invocation can also omit implementations for members of its interface. Example:

class MockList<T> implements List<T> {
  noSuchMethod(Invocation invocation) {
    log(invocation);
    super.noSuchMethod(invocation); // Will throw.
  }
}
void main() {
  MockList().add(42);
}

This code has no compile-time warnings or errors even though the MockList class has no concrete implementation of any of the List interface methods. Calls to List methods are forwarded to noSuchMethod, so this code will log an invocation similar to Invocation.method(#add, [42]) and then throw.

If a value is returned from noSuchMethod, it becomes the result of the original invocation. If the value is not of a type that can be returned by the original invocation, a type error occurs at the invocation.

The default behavior is to throw a NoSuchMethodError.

Inherited from Object.

Implementation

@pragma("vm:entry-point")
@pragma("wasm:entry-point")
external dynamic noSuchMethod(Invocation invocation);

parseArguments()

void parseArguments(List<String> arguments)

Call this with argv to set up the argument overrides. Applies to all children.

Implementation

void parseArguments(List<String> arguments) =>
    root._parseArguments(arguments);

toString() inherited

String toString()

A string representation of this object.

Some classes have a default textual representation, often paired with a static parse function (like int.parse). These classes will provide the textual representation as their string representation.

Other classes have no meaningful textual representation that a program will care about. Such classes will typically override toString to provide useful information when inspecting the object, mainly for debugging or logging.

Inherited from Object.

Implementation

external String toString();

traverse()

void traverse(void Function(DartdocOption<Object?> option) visit)

Apply the function visit to this DartdocOption and all children.

Implementation

void traverse(void Function(DartdocOption option) visit) {
  visit(this);
  for (var value in _children.values) {
    value.traverse(visit);
  }
}

valueAt()

dynamic valueAt(Folder dir)

Return the calculated value of this option, given the directory as context.

If isFile or isDir is set, the returned value will be transformed into a canonical path relative to the current working directory (for arguments) or the config file from which the value was derived.

May throw DartdocOptionError if a command line argument is of the wrong type. If mustExist is true, will throw DartdocFileMissing for command line parameters and file paths in config files that don't point to corresponding files or directories.

Implementation

// TODO(jcollins-g): use of dynamic.  https://github.com/dart-lang/dartdoc/issues/2814
dynamic valueAt(Folder dir);

valueAtCurrent()

Object? valueAtCurrent()

Calls valueAt with the working directory at the start of the program.

Implementation

Object? valueAtCurrent() => valueAt(_directoryCurrent);

Operators

operator ==() inherited

bool operator ==(Object other)

The equality operator.

The default behavior for all Objects is to return true if and only if this object and other are the same object.

Override this method to specify a different equality relation on a class. The overriding method must still be an equivalence relation. That is, it must be:

• Total: It must return a boolean for all arguments. It should never throw.

• Reflexive: For all objects o, o == o must be true.

• Symmetric: For all objects o1 and o2, o1 == o2 and o2 == o1 must either both be true, or both be false.

• Transitive: For all objects o1, o2, and o3, if o1 == o2 and o2 == o3 are true, then o1 == o3 must be true.

The method should also be consistent over time, so whether two objects are equal should only change if at least one of the objects was modified.

If a subclass overrides the equality operator, it should override the hashCode method as well to maintain consistency.

Inherited from Object.

Implementation

external bool operator ==(Object other);

operator

DartdocOption<Object?> operator [](String name)

Get the immediate child of this node named name.

Implementation

DartdocOption operator [](String name) {
  return _children[name]!;
}