pkgs/ffigen/lib/src/code_generator/constant.dart

// Copyright (c) 2020, the Dart project authors. 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.

import '../config_provider/public_ast.dart' as public_ast;
import '../header_parser/sub_parsers/api_availability.dart';
import '../visitor/ast.dart';
import 'binding.dart';
import 'binding_string.dart';
import 'scope.dart';
import 'utils.dart';
import 'writer.dart';

/// Base class for constants.
///
/// Expands to -
/// ```dart
/// const <type> <name> = <rawValue>;
/// ```
///
/// Example -
/// ```dart
/// const int name = 10;
/// ```
abstract class Constant extends NoLookUpBinding {
  /// The rawType is pasted as it is. E.g 'int', 'String', 'double'
  final String rawType;

  /// The rawValue is pasted as it is.
  ///
  /// Put quotes if type is a string.
  final String rawValue;

  final ApiAvailability? apiAvailability;

  bool isIncluded = false;

  Constant({
    super.usr,
    super.originalName,
    required String name,
    super.dartDoc,
    required this.rawType,
    required this.rawValue,
    this.apiAvailability,
  }) : super(symbol: Symbol(name, SymbolKind.field));

  @override
  BindingString toBindingString(Writer w) {
    final s = StringBuffer();
    final constantName = name;

    s.write(makeDartDoc(dartDoc));
    final deprecatedAnnotation = apiAvailability?.deprecatedAnnotation;
    if (deprecatedAnnotation != null) {
      s.write('$deprecatedAnnotation\n');
    }
    s.write('\nconst $rawType $constantName = $rawValue;\n\n');

    return BindingString(
      type: BindingStringType.constant,
      string: s.toString(),
    );
  }
}

/// A [Constant] defined by an unnamed enum.
class UnnamedEnumConstant extends Constant {
  UnnamedEnumConstant({
    super.usr,
    super.originalName,
    required super.name,
    super.dartDoc,
    required super.rawType,
    required super.rawValue,
    super.apiAvailability,
  });

  @override
  public_ast.AstNode? toPublicAstNode() => public_ast.UnnamedEnumConstant(this);

  @override
  void visit(Visitation visitation) =>
      visitation.visitUnnamedEnumConstant(this);
}

/// A [Constant] defined by a macro.
class MacroConstant extends Constant {
  MacroConstant({
    super.usr,
    super.originalName,
    required super.name,
    super.dartDoc,
    required super.rawType,
    required super.rawValue,
    super.apiAvailability,
  });

  @override
  public_ast.AstNode? toPublicAstNode() => public_ast.MacroConstant(this);

  @override
  void visit(Visitation visitation) => visitation.visitMacroConstant(this);
}