commit | 10b63fe66fe57458c4f249f346f26f4ed734bb7b | [log] [tgz] |
---|---|---|
author | S. Ganesh <ganesh@chromium.org> | Thu Apr 20 21:22:00 2023 |
committer | Chromium LUCI CQ <chromium-scoped@luci-project-accounts.iam.gserviceaccount.com> | Thu Apr 20 21:22:00 2023 |
tree | 9c1f4801884294dddf06157e0e774a5ed9d095fe | |
parent | ea7644264dc1849cf8000d61d27429ddeee5f871 [diff] |
Introduce a tool to generate distinct user/system interface definitions This CL introduces a tool for generating IDL files from a template, with distinct user and system identities for interfaces that are decorated with `BEGIN_INTERFACE` and `END_INTERFACE`. This improves on a few things: * Reduces manual effort when introducing new interfaces, or making changes to existing interfaces. * Reduces the chance for errors such as one interface changed by hand but not the other because it's automated. * Will make it easy to make future changes to make the legacy interfaces work without causing `TYPE_E_CANTLOADLIBRARY` errors. This CL also modifies a single interface in `updater_idl.template` for the moment. The next follow-up change will change all the remaining interfaces to use this approach, as well as update the documentation. `BEGIN_INTERFACE` takes the placeholder guid, the interface that needs distinct identities, as well as any other items that need to be distinct for `user` and `system` respectively. Here is an example: ``` BEGIN_INTERFACE( { "user": { "PLACEHOLDER-GUID-2FCD14AF-B645-4351-8359-E80A0E202A0B": "PLACEHOLDER-GUID-9AD1A645-5A4B-4D36-BC21-F0059482E6EA", "ICompleteStatus":"ICompleteStatusUser" }, "system": { "PLACEHOLDER-GUID-2FCD14AF-B645-4351-8359-E80A0E202A0B": "PLACEHOLDER-GUID-E2BD9A6B-0A19-4C89-AE8B-B7E9E51D9A07", "ICompleteStatus":"ICompleteStatusSystem" } } ) [ uuid(PLACEHOLDER-GUID-2FCD14AF-B645-4351-8359-E80A0E202A0B), oleautomation, pointer_default(unique) ] interface ICompleteStatus : IUnknown { [propget] HRESULT statusCode([out, retval] LONG*); [propget] HRESULT statusMessage([out, retval] BSTR*); }; END_INTERFACE ``` The example input above will produce the following output in the IDL: ``` [ uuid(PLACEHOLDER-GUID-2FCD14AF-B645-4351-8359-E80A0E202A0B), oleautomation, pointer_default(unique) ] interface ICompleteStatus : IUnknown { [propget] HRESULT statusCode([out, retval] LONG*); [propget] HRESULT statusMessage([out, retval] BSTR*); }; [ uuid(PLACEHOLDER-GUID-9AD1A645-5A4B-4D36-BC21-F0059482E6EA), oleautomation, pointer_default(unique) ] interface ICompleteStatusUser : IUnknown { [propget] HRESULT statusCode([out, retval] LONG*); [propget] HRESULT statusMessage([out, retval] BSTR*); }; [ uuid(PLACEHOLDER-GUID-E2BD9A6B-0A19-4C89-AE8B-B7E9E51D9A07), oleautomation, pointer_default(unique) ] interface ICompleteStatusSystem : IUnknown { [propget] HRESULT statusCode([out, retval] LONG*); [propget] HRESULT statusMessage([out, retval] BSTR*); }; ``` Bug: 1434887 Change-Id: I3cbf4321bdac1e7ddbe26c1ba4cccc061b0e15c6 Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/4450700 Code-Coverage: Findit <findit-for-me@appspot.gserviceaccount.com> Commit-Queue: S Ganesh <ganesh@chromium.org> Auto-Submit: S Ganesh <ganesh@chromium.org> Reviewed-by: Xiaoling Bao <xiaolingbao@chromium.org> Commit-Queue: Xiaoling Bao <xiaolingbao@chromium.org> Cr-Commit-Position: refs/heads/main@{#1133375}
Chromium is an open-source browser project that aims to build a safer, faster, and more stable way for all users to experience the web.
The project's web site is https://www.chromium.org.
To check out the source code locally, don't use git clone
! Instead, follow the instructions on how to get the code.
Documentation in the source is rooted in docs/README.md.
Learn how to Get Around the Chromium Source Code Directory Structure .
For historical reasons, there are some small top level directories. Now the guidance is that new top level directories are for product (e.g. Chrome, Android WebView, Ash). Even if these products have multiple executables, the code should be in subdirectories of the product.
If you found a bug, please file it at https://crbug.com/new.