built_value_generator/lib/src/serializer_source_field.dart - third_party/dart-pkg - Git at Google

 // Copyright (c) 2015, Google Inc. Please see the AUTHORS file for details.
 // All rights reserved. Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.

 library built_value_generator.source_field;

 import 'package:analyzer/dart/analysis/results.dart';
 import 'package:analyzer/dart/ast/ast.dart';
 import 'package:analyzer/dart/element/element.dart';
 import 'package:analyzer/dart/element/type.dart';
 import 'package:built_collection/built_collection.dart';
 import 'package:built_value/built_value.dart';
 import 'package:built_value_generator/src/dart_types.dart';
 import 'package:built_value_generator/src/metadata.dart'
     show metadataToStringValue;

 part 'serializer_source_field.g.dart';

 abstract class SerializerSourceField
     implements Built<SerializerSourceField, SerializerSourceFieldBuilder> {
   static final BuiltMap<String, String> typesWithBuilder =
       BuiltMap<String, String>({
     'BuiltList': 'ListBuilder',
     'BuiltListMultimap': 'ListMultimapBuilder',
     'BuiltMap': 'MapBuilder',
     'BuiltSet': 'SetBuilder',
     'BuiltSetMultimap': 'SetMultimapBuilder',
   });
   BuiltValue get settings;
   ParsedLibraryResult get parsedLibrary;
   FieldElement get element;
   @nullable
   FieldElement get builderElement;

   factory SerializerSourceField(
           BuiltValue settings,
           ParsedLibraryResult parsedLibrary,
           FieldElement element,
           FieldElement builderElement) =>
       _$SerializerSourceField._(
           settings: settings,
           parsedLibrary: parsedLibrary,
           element: element,
           builderElement: builderElement);
   SerializerSourceField._();

   @memoized
   bool get isSerializable =>
       element.getter != null &&
       element.getter.isAbstract &&
       !element.isStatic &&
       (builtValueField.serialize ?? settings.defaultSerialize);

   @memoized
   BuiltValueField get builtValueField {
     var annotations = element.getter.metadata
         .map((annotation) => annotation.computeConstantValue())
         .where((value) => DartTypes.getName(value?.type) == 'BuiltValueField');
     if (annotations.isEmpty) return const BuiltValueField();
     var annotation = annotations.single;
     return BuiltValueField(
         compare: annotation.getField('compare').toBoolValue(),
         serialize: annotation.getField('serialize').toBoolValue(),
         wireName: annotation.getField('wireName').toStringValue());
   }

   @memoized
   bool get isNullable => element.getter.metadata
       .any((metadata) => metadataToStringValue(metadata) == 'nullable');

   @memoized
   String get name => element.displayName;

   @memoized
   String get wireName => builtValueField.wireName ?? name;

   @memoized
   String get type => DartTypes.getName(element.getter.returnType);

   /// The [type] plus any import prefix.
   @memoized
   String get typeWithPrefix {
     var declaration = parsedLibrary.getElementDeclaration(element.getter);
     var typeFromAst =
         (declaration.node as MethodDeclaration)?.returnType?.toString() ??
             'dynamic';
     var typeFromElement = type;

     // If the type is a function, we can't use the element result; it is
     // formatted incorrectly.
     if (typeFromElement.contains('(')) return typeFromAst;

     // If the type does not have an import prefix, prefer the element result.
     // It handles inherited generics correctly.
     if (!typeFromAst.contains('.')) return typeFromElement;

     return typeFromAst;
   }

   /// Returns the type with import prefix if the compilation unit matches,
   /// otherwise the type with no import prefix.
   String typeInCompilationUnit(CompilationUnitElement compilationUnitElement) {
     return compilationUnitElement == element.library.definingCompilationUnit
         ? typeWithPrefix
         : type;
   }

   @memoized
   bool get builderFieldUsesNestedBuilder {
     var builderFieldElementIsValid =
         (builderElement?.getter?.isAbstract == false) &&
             !builderElement.isStatic;

     // If the builder is present, check it to determine whether a nested
     // builder is needed. Otherwise, use the same logic as built_value when
     // it decides whether to use a nested builder.
     return builderFieldElementIsValid
         ? DartTypes.getName(element.getter.returnType) !=
             DartTypes.getName(builderElement.getter.returnType)
         : settings.nestedBuilders &&
             DartTypes.needsNestedBuilder(element.getter.returnType);
   }

   @memoized
   String get rawType => _getBareType(type);

   String generateFullType(CompilationUnitElement compilationUnit,
       [BuiltSet<String> classGenericParameters]) {
     return _generateFullType(typeInCompilationUnit(compilationUnit),
         classGenericParameters ?? BuiltSet<String>());
   }

   @memoized
   bool get needsBuilder =>
       DartTypes.getName(element.getter.returnType).contains('<') &&
       DartTypes.isBuilt(element.getter.returnType);

   Iterable<String> computeErrors() {
     if (isSerializable && element.getter.returnType is FunctionType) {
       return [
         'Function fields are not serializable. '
             'Remove "$name" or mark it "@BuiltValueField(serialize: false)".'
       ];
     }

     return [];
   }

   /// Generates a cast using 'as' to this field type.
   ///
   /// Generics are cast to the bound of the generic. If there is no bound,
   /// no cast is needed, and an empty string is returned.
   String generateCast(CompilationUnitElement compilationUnit,
       BuiltMap<String, String> classGenericBounds) {
     var result = _generateCast(
         typeInCompilationUnit(compilationUnit), classGenericBounds);
     return result == 'Object' ? '' : 'as $result';
   }

   String generateBuilder() {
     var bareType = _getBareType(type);
     if (typesWithBuilder.containsKey(bareType)) {
       return 'new ${typesWithBuilder[bareType]}<${_getGenerics(type)}>()';
     } else {
       return 'new ${bareType}Builder<${_getGenerics(type)}>()';
     }
   }

   static String _generateFullType(
       String type, BuiltSet<String> classGenericParameters) {
     var bareType = _getBareType(type);
     var generics = _getGenerics(type);
     var genericItems = _splitOnTopLevelCommas(generics);

     if (generics.isEmpty) {
       if (classGenericParameters.contains(bareType)) {
         return 'parameter$bareType';
       }
       return 'const FullType($bareType)';
     } else {
       final parameterFullTypes = genericItems
           .map((item) => _generateFullType(item, classGenericParameters))
           .join(', ');
       final canUseConst = parameterFullTypes.startsWith('const ');
       final constOrNew = canUseConst ? 'const' : 'new';
       final constOrEmpty = canUseConst ? 'const' : '';
       return '$constOrNew FullType($bareType, $constOrEmpty [$parameterFullTypes])';
     }
   }

   static String _generateCast(
       String type, BuiltMap<String, String> classGenericBounds,
       {bool topLevel = true}) {
     var bareType = _getBareType(type);

     // For built collections we can cast to the dynamic type when deserializing,
     // instead of the actual generic type. This is because the `replace` method
     // checks the generic type and copies if needed.
     String generics;
     if (topLevel && DartTypes.isBuiltCollectionTypeName(bareType)) {
       if (bareType == 'BuiltList' || bareType == 'BuiltSet') {
         generics = 'dynamic';
       } else if (bareType == 'BuiltMap' ||
           bareType == 'BuiltListMultimap' ||
           bareType == 'BuiltSetMultimap') {
         generics = 'dynamic, dynamic';
       } else {
         throw UnsupportedError('Bare type is a built_collection type, but not '
             'one of the known built_collection types: $bareType.');
       }
     } else {
       generics = _getGenerics(type);
     }
     var genericItems = _splitOnTopLevelCommas(generics);

     if (generics.isEmpty) {
       if (classGenericBounds.keys.contains(bareType)) {
         return classGenericBounds[bareType];
       }
       return bareType;
     } else {
       final parameterFullTypes = genericItems
           .map((item) =>
               _generateCast(item, classGenericBounds, topLevel: false))
           .join(', ');
       return '$bareType<$parameterFullTypes>';
     }
   }

   static String _getBareType(String name) {
     var genericsStart = name.indexOf('<');
     return genericsStart == -1 ? name : name.substring(0, genericsStart);
   }

   static String _getGenerics(String name) {
     var genericsStart = name.indexOf('<');
     return genericsStart == -1
         ? ''
         : name
             .substring(genericsStart + 1)
             .substring(0, name.length - genericsStart - 2);
   }

   /// Splits a generic parameter string on top level commas; that means
   /// commas nested inside '<' and '>' are ignored.
   static BuiltList<String> _splitOnTopLevelCommas(String string) {
     var result = ListBuilder<String>();
     var accumulator = StringBuffer();
     var depth = 0;
     for (var i = 0; i != string.length; ++i) {
       if (string[i] == '<') ++depth;
       if (string[i] == '>') --depth;

       if (string[i] == ',' && depth == 0) {
         result.add(accumulator.toString().trim());
         accumulator.clear();
       } else {
         accumulator.write(string[i]);
       }
     }
     if (accumulator.isNotEmpty) {
       result.add(accumulator.toString().trim());
     }
     return result.build();
   }
 }
	// Copyright (c) 2015, Google Inc. Please see the AUTHORS file for details.
	// All rights reserved. Use of this source code is governed by a BSD-style
	// license that can be found in the LICENSE file.

	library built_value_generator.source_field;

	import 'package:analyzer/dart/analysis/results.dart';
	import 'package:analyzer/dart/ast/ast.dart';
	import 'package:analyzer/dart/element/element.dart';
	import 'package:analyzer/dart/element/type.dart';
	import 'package:built_collection/built_collection.dart';
	import 'package:built_value/built_value.dart';
	import 'package:built_value_generator/src/dart_types.dart';
	import 'package:built_value_generator/src/metadata.dart'
	show metadataToStringValue;

	part 'serializer_source_field.g.dart';

	abstract class SerializerSourceField
	implements Built<SerializerSourceField, SerializerSourceFieldBuilder> {
	static final BuiltMap<String, String> typesWithBuilder =
	BuiltMap<String, String>({
	'BuiltList': 'ListBuilder',
	'BuiltListMultimap': 'ListMultimapBuilder',
	'BuiltMap': 'MapBuilder',
	'BuiltSet': 'SetBuilder',
	'BuiltSetMultimap': 'SetMultimapBuilder',
	});
	BuiltValue get settings;
	ParsedLibraryResult get parsedLibrary;
	FieldElement get element;
	@nullable
	FieldElement get builderElement;

	factory SerializerSourceField(
	BuiltValue settings,
	ParsedLibraryResult parsedLibrary,
	FieldElement element,
	FieldElement builderElement) =>
	_$SerializerSourceField._(
	settings: settings,
	parsedLibrary: parsedLibrary,
	element: element,
	builderElement: builderElement);
	SerializerSourceField._();

	@memoized
	bool get isSerializable =>
	element.getter != null &&
	element.getter.isAbstract &&
	!element.isStatic &&
	(builtValueField.serialize ?? settings.defaultSerialize);

	@memoized
	BuiltValueField get builtValueField {
	var annotations = element.getter.metadata
	.map((annotation) => annotation.computeConstantValue())
	.where((value) => DartTypes.getName(value?.type) == 'BuiltValueField');
	if (annotations.isEmpty) return const BuiltValueField();
	var annotation = annotations.single;
	return BuiltValueField(
	compare: annotation.getField('compare').toBoolValue(),
	serialize: annotation.getField('serialize').toBoolValue(),
	wireName: annotation.getField('wireName').toStringValue());
	}

	@memoized
	bool get isNullable => element.getter.metadata
	.any((metadata) => metadataToStringValue(metadata) == 'nullable');

	@memoized
	String get name => element.displayName;

	@memoized
	String get wireName => builtValueField.wireName ?? name;

	@memoized
	String get type => DartTypes.getName(element.getter.returnType);

	/// The [type] plus any import prefix.
	@memoized
	String get typeWithPrefix {
	var declaration = parsedLibrary.getElementDeclaration(element.getter);
	var typeFromAst =
	(declaration.node as MethodDeclaration)?.returnType?.toString() ??
	'dynamic';
	var typeFromElement = type;

	// If the type is a function, we can't use the element result; it is
	// formatted incorrectly.
	if (typeFromElement.contains('(')) return typeFromAst;

	// If the type does not have an import prefix, prefer the element result.
	// It handles inherited generics correctly.
	if (!typeFromAst.contains('.')) return typeFromElement;

	return typeFromAst;
	}

	/// Returns the type with import prefix if the compilation unit matches,
	/// otherwise the type with no import prefix.
	String typeInCompilationUnit(CompilationUnitElement compilationUnitElement) {
	return compilationUnitElement == element.library.definingCompilationUnit
	? typeWithPrefix
	: type;
	}

	@memoized
	bool get builderFieldUsesNestedBuilder {
	var builderFieldElementIsValid =
	(builderElement?.getter?.isAbstract == false) &&
	!builderElement.isStatic;

	// If the builder is present, check it to determine whether a nested
	// builder is needed. Otherwise, use the same logic as built_value when
	// it decides whether to use a nested builder.
	return builderFieldElementIsValid
	? DartTypes.getName(element.getter.returnType) !=
	DartTypes.getName(builderElement.getter.returnType)
	: settings.nestedBuilders &&
	DartTypes.needsNestedBuilder(element.getter.returnType);
	}

	@memoized
	String get rawType => _getBareType(type);

	String generateFullType(CompilationUnitElement compilationUnit,
	[BuiltSet<String> classGenericParameters]) {
	return _generateFullType(typeInCompilationUnit(compilationUnit),
	classGenericParameters ?? BuiltSet<String>());
	}

	@memoized
	bool get needsBuilder =>
	DartTypes.getName(element.getter.returnType).contains('<') &&
	DartTypes.isBuilt(element.getter.returnType);

	Iterable<String> computeErrors() {
	if (isSerializable && element.getter.returnType is FunctionType) {
	return [
	'Function fields are not serializable. '
	'Remove "$name" or mark it "@BuiltValueField(serialize: false)".'
	];
	}

	return [];
	}

	/// Generates a cast using 'as' to this field type.
	///
	/// Generics are cast to the bound of the generic. If there is no bound,
	/// no cast is needed, and an empty string is returned.
	String generateCast(CompilationUnitElement compilationUnit,
	BuiltMap<String, String> classGenericBounds) {
	var result = _generateCast(
	typeInCompilationUnit(compilationUnit), classGenericBounds);
	return result == 'Object' ? '' : 'as $result';
	}

	String generateBuilder() {
	var bareType = _getBareType(type);
	if (typesWithBuilder.containsKey(bareType)) {
	return 'new ${typesWithBuilder[bareType]}<${_getGenerics(type)}>()';
	} else {
	return 'new ${bareType}Builder<${_getGenerics(type)}>()';
	}
	}

	static String _generateFullType(
	String type, BuiltSet<String> classGenericParameters) {
	var bareType = _getBareType(type);
	var generics = _getGenerics(type);
	var genericItems = _splitOnTopLevelCommas(generics);

	if (generics.isEmpty) {
	if (classGenericParameters.contains(bareType)) {
	return 'parameter$bareType';
	}
	return 'const FullType($bareType)';
	} else {
	final parameterFullTypes = genericItems
	.map((item) => _generateFullType(item, classGenericParameters))
	.join(', ');
	final canUseConst = parameterFullTypes.startsWith('const ');
	final constOrNew = canUseConst ? 'const' : 'new';
	final constOrEmpty = canUseConst ? 'const' : '';
	return '$constOrNew FullType($bareType, $constOrEmpty [$parameterFullTypes])';
	}
	}

	static String _generateCast(
	String type, BuiltMap<String, String> classGenericBounds,
	{bool topLevel = true}) {
	var bareType = _getBareType(type);

	// For built collections we can cast to the dynamic type when deserializing,
	// instead of the actual generic type. This is because the `replace` method
	// checks the generic type and copies if needed.
	String generics;
	if (topLevel && DartTypes.isBuiltCollectionTypeName(bareType)) {
	if (bareType == 'BuiltList' \|\| bareType == 'BuiltSet') {
	generics = 'dynamic';
	} else if (bareType == 'BuiltMap' \|\|
	bareType == 'BuiltListMultimap' \|\|
	bareType == 'BuiltSetMultimap') {
	generics = 'dynamic, dynamic';
	} else {
	throw UnsupportedError('Bare type is a built_collection type, but not '
	'one of the known built_collection types: $bareType.');
	}
	} else {
	generics = _getGenerics(type);
	}
	var genericItems = _splitOnTopLevelCommas(generics);

	if (generics.isEmpty) {
	if (classGenericBounds.keys.contains(bareType)) {
	return classGenericBounds[bareType];
	}
	return bareType;
	} else {
	final parameterFullTypes = genericItems
	.map((item) =>
	_generateCast(item, classGenericBounds, topLevel: false))
	.join(', ');
	return '$bareType<$parameterFullTypes>';
	}
	}

	static String _getBareType(String name) {
	var genericsStart = name.indexOf('<');
	return genericsStart == -1 ? name : name.substring(0, genericsStart);
	}

	static String _getGenerics(String name) {
	var genericsStart = name.indexOf('<');
	return genericsStart == -1
	? ''
	: name
	.substring(genericsStart + 1)
	.substring(0, name.length - genericsStart - 2);
	}

	/// Splits a generic parameter string on top level commas; that means
	/// commas nested inside '<' and '>' are ignored.
	static BuiltList<String> _splitOnTopLevelCommas(String string) {
	var result = ListBuilder<String>();
	var accumulator = StringBuffer();
	var depth = 0;
	for (var i = 0; i != string.length; ++i) {
	if (string[i] == '<') ++depth;
	if (string[i] == '>') --depth;

	if (string[i] == ',' && depth == 0) {
	result.add(accumulator.toString().trim());
	accumulator.clear();
	} else {
	accumulator.write(string[i]);
	}
	}
	if (accumulator.isNotEmpty) {
	result.add(accumulator.toString().trim());
	}
	return result.build();
	}
	}