mirror of
https://bitbucket.org/chromiumembedded/cef
synced 2025-04-05 14:41:09 +02:00
dd81904a2f
- Generated files are now created when running cef_create_projects or the new version_manager.py tool. These files are still created in the cef/ source tree (same location as before) but Git ignores them due to the generated .gitignore file. - API hashes are committed to Git as a new cef_api_versions.json file. This file is used for both code generation and CEF version calculation (replacing the previous usage of cef_api_hash.h for this purpose). It will be updated by the CEF admin before merging breaking API changes upstream. - As an added benefit to the above, contributor PRs will no longer contain generated code that is susceptible to frequent merge conflicts. - From a code generation perspective, the main difference is that we now use versioned structs (e.g. cef_browser_0_t instead of cef_browser_t) on the libcef (dll/framework) side. Most of the make_*.py tool changes are related to supporting this. - From the client perspective, you can now define CEF_API_VERSION in the project configuration (or get CEF_EXPERIMENTAL by default). This define will change the API exposed in CEF’s include/ and include/capi header files. All client-side targets including libcef_dll_wrapper will need be recompiled when changing this define. - Examples of the new API-related define usage are provided in cef_api_version_test.h, api_version_test_impl.cc and api_version_unittest.cc. To test: - Run `ceftests --gtest_filter=ApiVersionTest.*` - Add `cef_api_version=13300` to GN_DEFINES. Re-run configure, build and ceftests steps. - Repeat with 13301, 13302, 13303 (all supported test versions).
131 lines
3.4 KiB
Python
131 lines
3.4 KiB
Python
# Copyright (c) 2024 The Chromium Embedded Framework Authors. All rights
|
|
# reserved. Use of this source code is governed by a BSD-style license that
|
|
# can be found in the LICENSE file.
|
|
|
|
from __future__ import absolute_import
|
|
from cef_parser import get_copyright
|
|
from file_util import write_file_if_changed
|
|
from version_util import read_version_files
|
|
import os
|
|
import sys
|
|
|
|
|
|
def make_api_versions_header(json):
|
|
result = get_copyright(full=True, translator=False) + \
|
|
"""//
|
|
// ---------------------------------------------------------------------------
|
|
//
|
|
// This file was generated by the make_api_versions_header.py tool. Versions
|
|
// are managed using the version_manager.py tool. For usage details see
|
|
// https://bitbucket.org/chromiumembedded/cef/wiki/ApiVersioning.md
|
|
//
|
|
|
|
#ifndef CEF_INCLUDE_CEF_API_VERSIONS_H_
|
|
#define CEF_INCLUDE_CEF_API_VERSIONS_H_
|
|
|
|
#include "include/base/cef_build.h"
|
|
"""
|
|
|
|
for version, hashes in json['hashes'].items():
|
|
version_part = """
|
|
// $COMMENT$
|
|
#define CEF_API_VERSION_$VER$ $VER$
|
|
#define CEF_API_HASH_$VER$_UNIVERSAL "$UNIVERSAL$"
|
|
#if defined(OS_WIN)
|
|
#define CEF_API_HASH_$VER$_PLATFORM "$WINDOWS$"
|
|
#elif defined(OS_MAC)
|
|
#define CEF_API_HASH_$VER$_PLATFORM "$MAC$"
|
|
#elif defined(OS_LINUX)
|
|
#define CEF_API_HASH_$VER$_PLATFORM "$LINUX$"
|
|
#endif
|
|
""".replace('$VER$', version)
|
|
|
|
# Substitute hash values for placeholders.
|
|
for key, value in hashes.items():
|
|
version_part = version_part.replace('$%s$' % key.upper(), value)
|
|
|
|
result += version_part
|
|
|
|
result += \
|
|
"""
|
|
// Oldest supported CEF version.
|
|
#define CEF_API_VERSION_MIN CEF_API_VERSION_$MIN$
|
|
|
|
// Newest supported CEF version.
|
|
#define CEF_API_VERSION_LAST CEF_API_VERSION_$LAST$
|
|
|
|
#endif // CEF_INCLUDE_CEF_API_VERSIONS_H_
|
|
""".replace('$LAST$', json['last']).replace('$MIN$', json['min'])
|
|
|
|
return result
|
|
|
|
|
|
def make_api_versions_inc(json):
|
|
result = get_copyright(full=False, translator=False) + \
|
|
"""//
|
|
// ---------------------------------------------------------------------------
|
|
//
|
|
// This file was generated by the make_api_versions_header.py tool.
|
|
//
|
|
|
|
namespace {
|
|
|
|
struct ApiVersionHash {
|
|
int version;
|
|
const char* const universal;
|
|
const char* const platform;
|
|
};
|
|
|
|
const ApiVersionHash kApiVersionHashes[] = {"""
|
|
|
|
for version, hashes in json['hashes'].items():
|
|
result += """
|
|
{$VER$, CEF_API_HASH_$VER$_UNIVERSAL, CEF_API_HASH_$VER$_PLATFORM},""".replace(
|
|
'$VER$', version)
|
|
|
|
result += \
|
|
"""
|
|
};
|
|
|
|
const size_t kApiVersionHashesSize = std::size(kApiVersionHashes);
|
|
|
|
} // namespace
|
|
"""
|
|
|
|
return result
|
|
|
|
|
|
def write_api_versions(out_header_file, out_inc_file, json):
|
|
out_file = os.path.abspath(out_header_file)
|
|
result = make_api_versions_header(json)
|
|
if not bool(result):
|
|
sys.stderr.write('Failed to create %s\n' % out_file)
|
|
sys.exit(1)
|
|
retval1 = write_file_if_changed(out_file, result)
|
|
|
|
out_file = os.path.abspath(out_inc_file)
|
|
result = make_api_versions_inc(json)
|
|
if not bool(result):
|
|
sys.stderr.write('Failed to create %s\n' % out_file)
|
|
sys.exit(1)
|
|
retval2 = write_file_if_changed(out_file, result)
|
|
|
|
return retval1 or retval2
|
|
|
|
|
|
def main(argv):
|
|
if len(argv) < 5:
|
|
print(
|
|
"Usage:\n %s <output_header_file> <output_inc_file> <api_versions_file> <api_untracked_file>"
|
|
% argv[0])
|
|
sys.exit(-1)
|
|
|
|
json, initialized = \
|
|
read_version_files(argv[3], argv[4], True, combine=True)
|
|
if not write_api_versions(argv[1], argv[2], json):
|
|
print('Nothing done')
|
|
|
|
|
|
if '__main__' == __name__:
|
|
main(sys.argv)
|