Skip to content
This repository was archived by the owner on Feb 25, 2025. It is now read-only.

[windows] Rework controller/engine interaction in the API#20266

Merged
stuartmorgan-g merged 3 commits intoflutter:masterfrom
stuartmorgan-g:windows-engine-view-api-rework
Aug 10, 2020
Merged

[windows] Rework controller/engine interaction in the API#20266
stuartmorgan-g merged 3 commits intoflutter:masterfrom
stuartmorgan-g:windows-engine-view-api-rework

Conversation

@stuartmorgan-g
Copy link
Copy Markdown
Contributor

Description

Changes the interaction between the view controller and engine in both the C API and
the engine API, so that there's always an engine (as on other platforms) rather than
the engine APIs being specific to headless mode.

While adjusting the C API, this does a large cleanup:

  • Renames all methods to follow a FlutterDesktop (prefix) + "class" name + method-style name.
    E.g., FlutterDestkopViewControllerCreate rather than FlutterDesktopCreateViewController.
    This makes it easier to see what functions operate on which conceptual "object" in the API.
  • Reorders and groups them by the object they operate on.

Related Issues

Fixes flutter/flutter#61966

Tests

I added the following tests: Adjusted client wrapper tests for the changes.

Checklist

Before you create this PR confirm that it meets all requirements listed below by checking the relevant checkboxes ([x]). This will ensure a smooth and quick review process.

  • I read the contributor guide and followed the process outlined there for submitting PRs.
  • I signed the CLA.
  • I read and followed the C++, Objective-C, Java style guides for the engine.
  • I read the tree hygiene wiki page, which explains my responsibilities.
  • I updated/added relevant documentation.
  • All existing and new tests are passing.
  • I am willing to follow-up on review comments in a timely manner.

Breaking Change

Did any tests fail when you ran them? Please read handling breaking changes.

This is only a breaking change at the C API level, so is very unlikely to affect actual users since the template only uses the C++ wrapper.

Copy link
Copy Markdown

@clarkezone clarkezone left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Couple of questions / comments, otherwise LGTM

Copy link
Copy Markdown

@clarkezone clarkezone left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Fix view/engine interaction in Windows API

3 participants