dart-lang / code_builder Goto Github PK

AFAIK, creating """string""" literals isn't supported. When supplying literal() with a multi-line string, it will output a string with single ' delimiters and the original newlines, resulting in syntax errors. Creating the literal manually isn't possible — StringLiteral isn't an exported class.

There's a workaround — never using """ in the generated code (for example, by escaping all newlines with \n).

I wonder if I'm missing something. If not and this functionality is supposed to be supported, let me know. I'd love to make a PR.

No way to generate the following code:
['foo', 'bar', 'baz']
[1, 2, 3]
['foo', 1]

EDIT: Downgraded to P3. Dart requiring constant values means this isn't used too often.

If it works, close dart-lang/matcher#36

/cc @yjbanov :)

This was patched internally to allow updating to 1.0.0-beta+3, but needs to be fixed ASAP.

expect(
list([1, 2, 3]).invoke('where', [
new MethodBuilder.closure(returns: literal(true))
..addPositional(parameter('', []))
]),
equalsSource('[1,2,3].where(() => true)'));

fails with
Expected: '[1,2,3].where(() => true)' ignoring whitespace
Actual: <Instance of 'MethodInvocationBuilder'>
Which: '[1, 2, 3].where(() => true;)'is '[1, 2, 3].where(() => true;)' with whitespace compressed

As far as I can tell, there's not way to create an empty return statement, such as "if (true) return;"

All I could find was ExpressionBuilder.asReturn(), which requires an actual expression to return.

'package:code_builder/dart/core.dart': error: line 111 pos 26: unexpected token 'Function'
  final ReferenceBuilder Function = _ref('Function');
                         ^
Process finished with exit code 254

https://github.com/dart-lang/code_builder/blob/master/lib/dart/core.dart#L111

  /// References [dart_core.Function].
  final ReferenceBuilder Function = _ref('Function');

Dart VM version: 1.22.0-edge.8cca41772d807594955c7e9312b36ab691cfc7fe (Fri Jan 27 14:35:59 2017) on "linux_x64"

code_builder-1.0.0-beta+1

Might be related to dart-lang/sdk#27527 (comment)

There is no ExportBuilder like there is ImportBuilder.

FileBuilder currently allows building both libraries and parts and it uses a runtime check to make sure we don't put import directives and such into part files. Instead, FileBuilder could be abstract and we could have LibraryBuilder and PartBuilder concrete implementations that prevent incorrect directives at the API level.

Strawman:

abstract class FileBuilder {
  void addClass();
  void addVariable();
  void addFunction();
}

class LibraryBuilder extends FileBuilder {
  void addImport();
  void addExport();
}

class PartBuilder extends FileBuilder {
  PartBuilder(String libraryName);
}

While you are at it, the CLA bot and other goodies too ;)

• travis
• coverage
• CLA labels

Blocked by dart-lang/sdk#27169.

There is no way to generate a deferred import, like "import 'package:foo' deferred as foo;

This is blocking the internal sync which uses a newer version of analyzer where things like AsyncExpression are now abstract classes and require the use of astFactory. Should be a simple fix.

I might be mistaken but I can't find anyway of making a factory constructor.

      FhirClientBrowser.fhirDataConnection
          .newInstance([reference('apiService')]).asReturn(),

results in

return new FhirDataConnection(apiService);
        // ^^^

but should be

return new _i5.FhirDataConnection(apiService);

An expression is also a statement. For example:

void main() {
  "blah".substring(1);  // expression used as statement
}

So this should be allowed:

var methodBuilder = new MethodBuilder(...);
methodBuilder.addStatement(new ExpressionBuilder.invoke('substring'd));

Right now, there's no way to create a closure expression. All we have is lamba() for MethodBuilders.

Example:
args.map((String arg) => doSomething(arg));

Fix:

  @override
  Annotation buildAnnotation([Scope scope]) {
    return astFactory.annotation(
      $at,
      identifier(scope, _name, _importFrom),
      null,
      null,
      null,
    );
  }

I want to create

    _toolbarService.title.listen((value) {
      title = value.join(' - ');
    });

but couldn't find a way

MethodBuilder.closure() expects an ExpressionBuilder but above would be a StatementBuilder

the following doesn't work:
new LibraryBuilder().addMember(literal(false).asConst('foo'));

ERROR: The argument type 'StatementBuilder' can't be assigned to the parameter type 'AstBuilder'.

TypeBuilder does not support generics / parameterized Types

Example:
List foo = [];

... to allow opt-outs for more advanced scenarios we won't/can't cover with builders.

Example use:

new ExpressionBuilder.raw('5 + 90 >> 2 | 3')

new StatementBuilder.raw(r'''
  switch (value) {
    case: ...
  }
''')

We also need to be able to support auto-scoping - we could use mustache:

new StatementBuilder.raw(r'''
  switch ({{value}}) {
    case 1:
      break;
    case 2:
      break;
  }
''')

Would ~roughly translate to:

switch ($scoped.value) {
  ...
}

I might be missing something obvious but I can't find a way of marking a method as static, I can see that static is mentioned in buildMethod but I can't find how to utilise this from MethodBuilder.

Potentially MethodModifier could be developed to support statics?

(@yjbanov suggested offline, here is my understanding)

Some builders are lazy, they don't actually emit an AST until toAst() is called. Others are behind-the-scenes writing to an AST object the entire time. This second pattern should be removed and replaced with lazy emitters.

Advantages:

• Performance (?): We aren't building AST objects until actually needed
• Consistency: i.e. You should be able to add builder A to builder B and mutate A after
• Support for alternative APIs (see below)

// Classic method.
clazz.addMethod(new MethodBuilder.returnVoid(name: 'foo'));

// Builder-type method
clazz.addMethod()
  ..setName('foo')
  ..setReturnVoid();

We could accomplish by having an API like:

MethodBuilder addMethod([MethodBuilder builder]) {
  builder ??= new MethodBuilder();
  _builders.add(builder);
  return builder;
}

Assigned to @yjbanov to review design before implementation 😀

mainMethod.addStatement(literal('foo').asFinal('bar'));

generates

final bar = 'foo';

I tried to get

final String bar = 'foo';

I know the type isn't necessary. Still curious if this is supported.

Currently, supplying empty string as the constructor argument results in called a named constructor whose name is empty, e.g.: Foo.(). That's not valid Dart, therefore the only interpretation of empty string should be to call the default constructor. null should be either disallowed or have the same behavior.

I would expect TypeBuilder to be a drop-in replacement for ReferenceBuilder, since TypeBuilder is the recommended way to create generic types.

It would be very helpful if we could do something like:

new TypeBuilder('StateError').newInstance(['Blah blah blah']).asThrow();

This would also work, and might be better than the original suggestion I had:

new ThrowExpression(...)

I have a branch where this change is implemented as an asThrow method on ExpressionBuilder instances, but it wouldn't be difficult for me to just expose the _ThrowExpression class I created.

Thoughts on this? Can I go ahead and submit a PR, or was I too vague and need to clarify?

Thanks in advance.

ImportBuilder doesn't support show/hide combinators.

I can't generate the code "import 'package:foo' show Foo, Bar hide Baz;"

https://gitter.im/dart-lang/TALK-general/archives/2016/12/01

I could see a Reference.toExportBuilder, would that help?

from

Günter Zöchbauer @zoechi Dec 01 18:56
@matanlurey code_builder question.
Do you know a way to get the import path back from a reference('name', 'path').
I try to create an export and I thing it would be nice if I could use the reference I already have.

Matan Lurey @matanlurey Dec 01 19:06
@zoechi No that is not possible. I don't expose anything you used to build - just complicates the API.

Günter Zöchbauer @zoechi Dec 01 19:08
@matanlurey didn't mean anyting, but it seemes reasonable to use a reference to build an export.

Matan Lurey @matanlurey Dec 01 19:09
I could see a Reference.toExportBuilder, would that help?

Cloned from master and after running pub get I'm getting 15 Invalid argument type errors relating to: ValidClassMember ValidMemberMember & ValidConstructorMember. Example below:

file: '/code_builder/lib/src/builders/class.dart'
severity: 'Error'
message: 'The argument type 'ValidClassMember' can't be assigned to the parameter type 'AnnotationBuilder'.'
at: '26,27'
source: 'dart'

No way to generate cascades

foo
..doThis()
..doThat()
..bar = new Bar();

I couldn't find a way to do that.

I build the class declaration for class AppComponent (for library a_lib) and need the type as parameter like

ClassBuilder appComponent = ...;
final mainMethod = new MethodBuilder.returnVoid('main')
..addStatement(AngularPlatformBrowser.bootstrapFunction
        .call([appComponent]))
               ^^^^^^^^^^^^

What is a good way to get from appComponent to the ExpressionBuilder required by call([...])

I hope you don't mind that I ask a few questions here to master the first hurdles.

class MyClass extends SuperClass {
  MyClass(String p) : super(p);
}

I haven't found anything that would allow to add the :super(p) part.

I couldn't find a way to define parameters

For example, imagine I was to construct a factory that forwards its parameters to a constructor:

class Foo {
  factory Foo(A a, B b, C c) {
    return new Foo._(a, b, c);
  }

  Foo._(A a, B b, C c);
}

To generate factory Foo(A a, B b, C c) I will have a List<ParameterBuilder>. To forward the parameters to Foo._, I want to be able to convert List<ParameterBuilder> to a List<ExpressionBuilder> args and pass that to myType.newInstance(args).

Example:

List<ExpressionBuilder> forwardParamsToArgs(List<ParameterBuilder> params) {
  return params.map<ExpressionBuilder>((p) => reference(p.name)).toList();
}

Unfortunately p.name does not exist.

I tried to generate code like

final dataConnection =  connections.getByName('foo') as FhirDataConnection;

but couldn't find a way.

expect(
new LibraryBuilder()
..addMember(new MethodBuilder.returnVoid('main')),
equalsSource('void main {}'));

Expected: 'void main {}' ignoring whitespace
Actual: <Instance of 'LibraryBuilder'>
Which: 'void main();'is 'void main();' with whitespace compressed