#!/usr/bin/env bash
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements.  See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You 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.

# SHELLDOC-IGNORE

add_test_type scalac
add_test_type scaladoc

SCALA_INITIALIZED=false

function scalac_filefilter
{
  declare filename=$1

  if [[ ${filename} =~ \.scala$ ]]; then
   yetus_debug "tests/scalac: ${filename}"
   add_test scalac
   add_test compile
  fi
}

function scaladoc_filefilter
{
  local filename=$1

  if [[ ${filename} =~ \.scala$ ]]; then
    yetus_debug "tests/scaladoc: ${filename}"
    add_test scaladoc
  fi
}

## @description  initialize the scala plug-in
## @audience     private
## @stability    evolving
## @replaceable  no
function scala_initialize
{
  if [[ ${SCALA_INITIALIZED} == true ]]; then
    return
  else
    SCALA_INITIALIZED=true
  fi

  if declare -f maven_add_install >/dev/null 2>&1; then
    maven_add_install scaladoc
    maven_add_install scalac
  fi
}

## @description  initialize the scalac plug-in
## @audience     private
## @stability    evolving
## @replaceable  no
function scalac_initialize
{
  scala_initialize
}

## @description  initialize the scaladoc plug-in
## @audience     private
## @stability    evolving
## @replaceable  no
function scaladoc_initialize
{
  scala_initialize
}

## @description
## @audience     private
## @stability    stable
## @replaceable  no
## @return       0 on success
## @return       1 on failure
function scalac_compile
{
  declare codebase=$1
  declare multijdkmode=$2

  if ! verify_needed_test scalac; then
    return 0
  fi

  if [[ ${codebase} = patch ]]; then
    module_postlog_compare compile scalac "${multijdkmode}"
  fi
}

## @description  Count and compare the number of ScalaDoc warnings pre- and post- patch
## @audience     private
## @stability    evolving
## @replaceable  no
## @return       0 on success
## @return       1 on failure
function scaladoc_rebuild
{
  declare codebase=$1

  if [[ "${codebase}" = branch ]]; then
    module_pre_handler scaladoc false
  else
    module_post_handler scaladoc scaladoc false true
  fi
}

## @description  Helper for generic_logfilter
## @audience     private
## @stability    evolving
## @replaceable  no
function scalac_logfilter
{
  declare input=$1
  declare output=$2

  "${GREP}" "^/.*.scala:[0-9]*:" "${input}" > "${output}"
}

## @description  Helper for generic_logfilter
## @audience     private
## @stability    evolving
## @replaceable  no
function scaladoc_logfilter
{
  declare input=$1
  declare output=$2

  "${GREP}" "^/.*.scala:[0-9]*:" "${input}" > "${output}"
}
