/* * Copyright (C) 2023 The Android Open Source Project * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ #ifndef SRC_TRACE_PROCESSOR_PERFETTO_SQL_INTRINSICS_FUNCTIONS_SQL_FUNCTION_H_ #define SRC_TRACE_PROCESSOR_PERFETTO_SQL_INTRINSICS_FUNCTIONS_SQL_FUNCTION_H_ #include <sqlite3.h> #include <memory> #include "perfetto/base/status.h" #include "perfetto/trace_processor/basic_types.h" namespace perfetto { namespace trace_processor { // Prototype for a C++ function which can be registered with SQLite. // // Usage // // Define a subclass of this struct as follows: // struct YourFunction : public SqlFunction { // // Optional if you want a custom context object (i.e. an object // // passed in at registration time which will be passed to Run on // // every invocation) // struct YourContext { /* define context fields here */ }; // // static base::Status Run(/* see parameters below */) { // /* function body here */ // } // // static base::Status Cleanup(/* see parameters below */) { // /* function body here */ // } // } // // Then, register this function with SQLite using RegisterFunction (see below); // you'll likely want to do this in TraceProcessorImpl: // RegisterFunction<YourFunction>(/* see arguments below */) struct SqlFunction { … }; } // namespace trace_processor } // namespace perfetto #endif // SRC_TRACE_PROCESSOR_PERFETTO_SQL_INTRINSICS_FUNCTIONS_SQL_FUNCTION_H_