regex_program.hpp

/*
 * Copyright (c) 2022-2024, NVIDIA CORPORATION.
 *
 * 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.
 */
#pragma once
 
#include <cudf/strings/regex/flags.hpp>
#include <cudf/types.hpp>
 
#include <memory>
#include <string>
 
namespace CUDF_EXPORT cudf {
namespace strings {
 
struct regex_program {
  struct regex_program_impl;
 
  static std::unique_ptr<regex_program> create(std::string_view pattern,
                                               regex_flags flags      = regex_flags::DEFAULT,
                                               capture_groups capture = capture_groups::EXTRACT);
 
  regex_program() = delete;
 
  regex_program(regex_program&& other);
 
  regex_program& operator=(regex_program&& other);
 
  [[nodiscard]] std::string pattern() const;
 
  [[nodiscard]] regex_flags flags() const;
 
  [[nodiscard]] capture_groups capture() const;
 
  [[nodiscard]] int32_t instructions_count() const;
 
  [[nodiscard]] int32_t groups_count() const;
 
  [[nodiscard]] std::size_t compute_working_memory_size(int32_t num_strings) const;
 
  ~regex_program();
 
 private:
  std::string _pattern;
  regex_flags _flags;
  capture_groups _capture;
 
  std::unique_ptr<regex_program_impl> _impl;
 
  regex_program(std::string_view pattern, regex_flags flags, capture_groups capture);
 
  friend struct regex_device_builder;
};
  // end of doxygen group
}  // namespace strings
}  // namespace CUDF_EXPORT cudf