[swift2objc] Support default parameter values (#1752) #2910

DPrakashhh · 2025-12-29T10:15:05Z

Description
This PR implements support for default parameter values in swift2objc by generating Objective-C compatible method overloads. Since Objective-C does not natively support default parameters, the wrapper now provides multiple versions of the same function, allowing the consumer to omit trailing arguments while preserving the original Swift default behavior.

Technical Changes
1- Model Layer: Added a defaultValue field to the Parameter model to store the default expression as a string.
2 - Parser Layer: Implemented logic in the Symbol Graph parser to extract default values from declarationFragments, handling both single and multi-token expressions.
3 - Transformer Layer: Updated the transformation logic to identify trailing parameters with defaults and generate $N$ overloads. This implementation supports methods, global functions, and initializers.
4 - Initializer Special Case: Resolved a mismatch in the expected output regarding @objc override public init() overloads to ensure proper Objective-C interop for default initializers.

Testing and Verification
1- Added unit tests to verify the correct parsing of numeric, string, and complex expression default values from the Symbol Graph.
2- Introduced an integration test fixture (default_params_input.swift) to demonstrate the end-to-end generation of overloaded wrapper code.
3- Verified the implementation against the full suite, with all 70 integration tests currently passing.

Open for your suggestion @liamappelbe :)
Fixes #1752

…#1752) - Add defaultValue field to Parameter model to store default expressions - Implement Symbol Graph parser to extract default values from declarationFragments - Generate method/function/initializer overloads for trailing default parameters - Each overload omits trailing defaults, allowing Swift to apply them natively - Add unit tests for parsing single/multiple/string default values - Add integration test fixture demonstrating full default parameter support - All 70 tests passing

google-cla · 2025-12-29T10:15:10Z

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

github-actions · 2025-12-29T22:24:33Z

PR Health

License Headers ✔️

// Copyright (c) 2025, 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.

Files
no missing headers

All source files should start with a license header.

Unrelated files missing license headers

Files
pkgs/hooks_runner/test_data/download_assets/hook/build.dart
pkgs/jni/test/debug_release_test.dart
pkgs/objective_c/example/command_line/lib/main.dart
pkgs/objective_c/lib/src/ns_input_stream.dart

This check can be disabled by tagging the PR with skip-license-check.

API leaks ✔️

The following packages contain symbols visible in the public API, but not exported by the library. Export these symbols or remove them from your publicly visible API.

Package	Leaked API symbol	Leaking sources

This check can be disabled by tagging the PR with skip-leaking-check.

Breaking changes ✔️

Package	Change	Current Version	New Version	Needed Version	Looking good?

This check can be disabled by tagging the PR with skip-breaking-check.

Changelog Entry ✔️

Package	Changed Files

Changes to files need to be accounted for in their respective changelogs.

This check can be disabled by tagging the PR with skip-changelog-check.

coveralls · 2025-12-29T22:28:27Z

coverage: 74.229%. remained the same
when pulling 2623056 on DPrakashhh:fix-default-params-1752
into 40ff8cd on dart-lang:main.

liamappelbe

Make sure you sign the CLA: #2910 (comment)

liamappelbe · 2025-12-30T00:06:13Z

pkgs/swift2objc/test/integration/default_params_input.swift

+import Foundation
+
+public class Greeter {
+    public func greet(name: String = "World", times: Int = 1) -> String {


Can you test the case of a non-trivial default value? Try an expression like 10 * foo where foo is a static variable on the class. I wonder if something like that would show up as multiple tokens.

This isn't resolved yet. Add a non-trivial default value to the integration test.

pkgs/swift2objc/lib/src/parser/parsers/declaration_parsers/parse_function_declaration.dart

pkgs/swift2objc/test/unit/parse_function_info_test.dart

pkgs/swift2objc/lib/src/transformer/transformers/transform_function.dart

liamappelbe · 2025-12-30T00:35:11Z

Make sure to also fix the formatting and analysis errors the bot found. I recommend running dart format . and dart analyze before you upload.

DPrakashhh · 2025-12-30T01:39:06Z

Thanks for the review. I'll work on it.

…hh/native into fix-default-params-1752 # Please enter a commit message to explain why this merge is necessary, # especially if it merges an updated upstream into a topic branch. # # Lines starting with '#' will be ignored, and an empty message aborts # the commit.

DPrakashhh · 2025-12-30T17:19:49Z

I have pushed the final refactor to address all review feedback. The implementation is now much more robust and aligned with the project's architecture:

1-Tokenizer Infrastructure: Moved the token-splitting logic into TokenList.splitToken. It now handles = as a splittable and correctly extracts trailing delimiters from the end of a token. This ensures complex default values are cleanly isolated.
2-Transformer Consolidation: Refactored _transformFunction to return a List, centralizing the overload generation logic. I’ve removed the redundant buildDefaultOverloads functions for methods, initializers, and global functions.
3-Resilient Parsing: Added a check in the parser to ensure string literals are treated as single tokens. This successfully handles the 'evil string' edge case (e.g., ") -> " inside a literal).
4- Consistency & Style: Switched all generated IDs to use the addIdSuffix() helper and ensured the codebase is clean according to dart format and dart analyze.
5- Testing: Added 6 new test cases covering non-trivial math expressions (like 10 * foo) and various delimiter-combined token formats.

All 75 tests are passing locally.

liamappelbe

I get the feeling that a lot of this code is AI generated. That's ok in general, as long as you're checking everything it writes, and making sure you understand it, and think about the implications of the changes you're making. In particular, AI tends to generate a lot of duplicated code, which is the main issue with this PR atm. AI also doesn't do a good job of addressing comments. It's your job to make sure my comments are addressed, and the code is well factorized/merged.

liamappelbe · 2026-01-02T01:05:29Z

pkgs/swift2objc/lib/src/parser/_core/token_list.dart

+  /// suffix cases.
+  ///
+  /// Swift's symbol graph concatenates some tokens together, for example when
+  /// a parameter has a default value: " = value) -> returnType" becomes a


Is this true? I don't think the returnType can be part of the token. If it can, then just taking splittables of the start and end won't work.

liamappelbe · 2026-01-02T01:09:29Z

pkgs/swift2objc/lib/src/parser/_core/token_list.dart

+
+      if (foundPrefix) continue;
+
+      // No more prefix splittables found; extract any trailing ones.


Move this out into its own while loop below the prefix extractor. Makes it more readable.

liamappelbe · 2026-01-02T01:18:05Z

pkgs/swift2objc/lib/src/parser/_core/token_list.dart

    }

-    var suffix = text;
+    var remaining = text;


I think this rename makes this more confusing. You've named this variable remaining, and the other one currentSuffix, but that's kinda the opposite of what they actually represent. We first remove prefixes, so what's left is a suffix. Then we remove suffixes, so what's left isn't really a suffix, and could be better named something generic like remaining. So I'd probably switch these names.

liamappelbe · 2026-01-02T01:31:27Z

pkgs/swift2objc/lib/src/parser/parsers/declaration_parsers/parse_function_declaration.dart

+      var afterType = maybeConsume('text');
+
+      if (afterType != null) {
+        // Check if this text token contains '='


A lot of this logic is outdated, now that all the token splitting is done in the token_list. If the token list is working correctly, you shouldn't ever need to further split tokens here, or do any string parsing at all. Each of the parts that you're checking for with these .startsWith and .contains calls should now be a separate token in the list that you receive from token_list.dart, and the default value itself should also be a single token.

It's often hard to modify complex code like this after such a big logic change elsewhere in the system, so I'd approach this by deleting this whole chunk of code, and starting over. Print out the token list that is received here, make sure it makes sense (ie, all tokens are split as you expect, and the default value is its own token), and then write a new parser for that token list. If you find yourself having to use String.split/substring/startsWith/contains in this area, then something is probably wrong in the token list logic.

If things work out like I'm expecting, then this whole chunk of code will be waaaay simpler after that rewrite.

liamappelbe · 2026-01-02T01:38:48Z

pkgs/swift2objc/lib/src/transformer/transformers/transform_compound.dart

-          ),
-        )
-        .toList();
+    final transformedInitializers = <Declaration>[];


Dart's fancy new collection literals can simplify this a bit. Something like this should work:

final transformedInitializers = <Declaration>[ for (final init in originalCompound.initializers) ...transformInitializerWithOverloads( init, wrappedCompoundInstance, parentNamer, state, ), ];

Same below

liamappelbe · 2026-01-02T01:54:31Z

pkgs/swift2objc/lib/src/transformer/transformers/transform_function.dart

  );

-  return transformedMethod;
+  // Generate overloads for trailing default parameters. Each overload omits


You haven't actually deduped the logic here, just combined the functions into one. Try to merge everything below here in this function with everything above. Eg, what happens if you let parametersToOmit start its loop at 0 instead of 1?

liamappelbe · 2026-01-02T01:57:50Z

pkgs/swift2objc/lib/src/transformer/transformers/transform_initializer.dart

  return (instanceConstruction, localNamer);
 }
+
+int _trailingDefaultCount(List<Parameter> params) {


dupe of the one in transform_compound

liamappelbe · 2026-01-02T01:58:59Z

pkgs/swift2objc/lib/src/transformer/transformers/transform_initializer.dart

+  return count;
+}
+
+List<String> _generateInitializerStatementsWithSubset(


can be merged with _generateInitializerStatements

liamappelbe · 2026-01-02T01:59:20Z

pkgs/swift2objc/lib/src/transformer/transformers/transform_initializer.dart

+  }
+}
+
+(String, UniqueNamer) _generateInstanceConstructionWithSubset(


Can be merged with _generateInstanceConstruction

liamappelbe · 2026-01-02T02:01:49Z

pkgs/swift2objc/test/integration/default_params_input.swift

+import Foundation
+
+public class Greeter {
+    public func greet(name: String = "World", times: Int = 1) -> String {


This isn't resolved yet. Add a non-trivial default value to the integration test.

DPrakashhh · 2026-01-02T03:35:50Z

I get the feeling that a lot of this code is AI generated. That's ok in general, as long as you're checking everything it writes, and making sure you understand it, and think about the implications of the changes you're making. In particular, AI tends to generate a lot of duplicated code, which is the main issue with this PR atm. AI also doesn't do a good job of addressing comments. It's your job to make sure my comments are addressed, and the code is well factorized/merged.

Hi Liam sir, thanks for being direct. I’m sorry for the oversight on the code quality and the duplication; I relied too much on AI to scaffold the serialization logic and didn't spend enough time factorizing it to meet the project's standards.

I have taken your feedback to heart. I'm going to step back and manually refactor the PR to remove the redundant logic and ensure all your comments are addressed individually. I want to make sure the final result is something I fully understand and can maintain. I’ll ping you when the next push is ready for a fresh look.

github-actions bot added the package:swift2objc label Dec 29, 2025

dcharkes requested a review from liamappelbe December 29, 2025 10:16

DPrakashhh added 2 commits December 29, 2025 15:54

Merge branch 'main' into fix-default-params-1752

0e087b9

Merge branch 'main' into fix-default-params-1752

97b8966

dcharkes mentioned this pull request Dec 29, 2025

[record_use] Completeness: enum value usages #2908

Open

liamappelbe reviewed Dec 30, 2025

View reviewed changes

DPrakashhh added 3 commits December 30, 2025 22:24

Refactor default parameter support to address all review feedback

fa5929b

Refactor: Finalize token splitting logic for default parameters

2623056

DPrakashhh requested a review from liamappelbe December 30, 2025 17:24

liamappelbe reviewed Jan 2, 2026

View reviewed changes


		if (foundPrefix) continue;

		// No more prefix splittables found; extract any trailing ones.

[swift2objc] Support default parameter values (#1752) #2910

Are you sure you want to change the base?

[swift2objc] Support default parameter values (#1752) #2910

Uh oh!

Conversation

DPrakashhh commented Dec 29, 2025

Uh oh!

google-cla bot commented Dec 29, 2025

Uh oh!

github-actions bot commented Dec 29, 2025

PR Health

Uh oh!

coveralls commented Dec 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

liamappelbe left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

liamappelbe commented Dec 30, 2025

Uh oh!

DPrakashhh commented Dec 30, 2025

Uh oh!

DPrakashhh commented Dec 30, 2025

Uh oh!

liamappelbe left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

DPrakashhh commented Jan 2, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

coveralls commented Dec 29, 2025 •

edited

Loading