1 /*
2  * Copyright (C) 2023 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 package com.android.tools.metalava.cli.common
18 
19 import com.github.ajalt.clikt.output.HelpFormatter.ParameterHelp
20 import com.github.ajalt.clikt.output.Localization
21 
22 /** Extends [MetalavaHelpFormatter] to append information about the legacy flags. */
23 internal class LegacyHelpFormatter(
24     terminalSupplier: () -> Terminal,
25     localization: Localization,
26     /** Provider for additional non-Clikt usage information. */
27     private val nonCliktUsageProvider: (Terminal, Int) -> String,
28 ) : MetalavaHelpFormatter(terminalSupplier, localization) {
formatHelpnull29     override fun formatHelp(
30         prolog: String,
31         epilog: String,
32         parameters: List<ParameterHelp>,
33         programName: String
34     ): String {
35         val extendedEpilog = "```${nonCliktUsageProvider(terminal, width)}```$epilog"
36         return super.formatHelp(prolog, extendedEpilog, parameters, programName)
37     }
38 }
39