/*
 * Copyright (C) 2021 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_PLUGINS_CREATE_VIEW_FUNCTION_CREATE_VIEW_FUNCTION_H_
#define SRC_TRACE_PROCESSOR_PLUGINS_CREATE_VIEW_FUNCTION_CREATE_VIEW_FUNCTION_H_

#include <cstddef>

#include "src/trace_processor/sqlite/bindings/sqlite_function.h"
#include "src/trace_processor/sqlite/bindings/sqlite_result.h"
#include "src/trace_processor/sqlite/bindings/sqlite_type.h"
#include "src/trace_processor/sqlite/bindings/sqlite_value.h"

namespace perfetto::trace_processor {

class PerfettoSqlConnection;

// Implementation of CREATE_VIEW_FUNCTION SQL function.
// See https://perfetto.dev/docs/analysis/metrics#metric-helper-functions for
// usage of this function.
struct CreateViewFunction : public sqlite::Function<CreateViewFunction> {
  static constexpr char kName[] = "create_view_function";
  static constexpr int kArgCount = 3;

  using UserData = PerfettoSqlConnection;
  static void Step(sqlite3_context* ctx, int argc, sqlite3_value** argv);
};

}  // namespace perfetto::trace_processor

namespace perfetto::trace_processor::create_view_function {

// Registers the CreateViewFunction plugin with the global plugin set.
// Idempotent; only the first call has an effect. Must run before the first
// GetPluginSet() call (i.e. before constructing TraceProcessorImpl).
void RegisterPlugin();

}  // namespace perfetto::trace_processor::create_view_function

#endif  // SRC_TRACE_PROCESSOR_PLUGINS_CREATE_VIEW_FUNCTION_CREATE_VIEW_FUNCTION_H_
