// This file is part of Substrate.

// Copyright (C) Parity Technologies (UK) Ltd.

// SPDX-License-Identifier: GPL-3.0-or-later WITH Classpath-exception-2.0

// This program is free software: you can redistribute it and/or modify

// it under the terms of the GNU General Public License as published by

// the Free Software Foundation, either version 3 of the License, or

// (at your option) any later version.

// This program is distributed in the hope that it will be useful,

// but WITHOUT ANY WARRANTY; without even the implied warranty of

// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

// GNU General Public License for more details.

// You should have received a copy of the GNU General Public License

// along with this program. If not, see <https://www.gnu.org/licenses/>.

//! Substrate CLI library.

//!

//! To see a full list of commands available, see [`commands`].

#![warn(missing_docs)]

#![warn(unused_extern_crates)]

#![warn(unused_imports)]

use clap::{CommandFactory, FromArgMatches, Parser};

use sc_service::Configuration;

pub mod arg_enums;

pub mod commands;

mod config;

mod error;

mod params;

mod runner;

mod signals;

pub use arg_enums::*;

pub use clap;

pub use commands::*;

pub use config::*;

pub use error::*;

pub use params::*;

pub use runner::*;

pub use sc_service::{ChainSpec, Role};

pub use sc_tracing::logging::LoggerBuilder;

pub use signals::Signals;

pub use sp_version::RuntimeVersion;

/// Substrate client CLI

///

/// This trait needs to be implemented on the root CLI struct of the application. It will provide

/// the implementation `name`, `version`, `executable name`, `description`, `author`, `support_url`,

/// `copyright start year` and most importantly: how to load the chain spec.

pub trait SubstrateCli: Sized {

	/// Implementation name.

	fn impl_name() -> String;

	/// Implementation version.

	///

	/// By default, it will look like this:

	///

	/// `2.0.0-b950f731c`

	///

	/// Where the hash is the short hash of the commit in the Git repository.

	fn impl_version() -> String;

	/// Executable file name.

	///

	/// Extracts the file name from `std::env::current_exe()`.

	/// Resorts to the env var `CARGO_PKG_NAME` in case of Error.

	/// Executable file description.

	fn description() -> String;

	/// Executable file author.

	fn author() -> String;

	/// Support URL.

	fn support_url() -> String;

	/// Copyright starting year (x-current year)

	fn copyright_start_year() -> i32;

	/// Chain spec factory

	fn load_spec(&self, id: &str) -> std::result::Result<Box<dyn ChainSpec>, String>;

	/// Helper function used to parse the command line arguments. This is the equivalent of

	/// [`clap::Parser::parse()`].

	///

	/// To allow running the node without subcommand, it also sets a few more settings:

	/// [`clap::Command::propagate_version`], [`clap::Command::args_conflicts_with_subcommands`],

	/// [`clap::Command::subcommand_negates_reqs`].

	///

	/// Creates `Self` from the command line arguments. Print the

	/// error message and quit the program in case of failure.

	/// Helper function used to parse the command line arguments. This is the equivalent of

	/// [`clap::Parser::parse_from`].

	///

	/// To allow running the node without subcommand, it also sets a few more settings:

	/// [`clap::Command::propagate_version`], [`clap::Command::args_conflicts_with_subcommands`],

	/// [`clap::Command::subcommand_negates_reqs`].

	///

	/// Creates `Self` from any iterator over arguments.

	/// Print the error message and quit the program in case of failure.

	/// Helper function used to parse the command line arguments. This is the equivalent of

	/// [`clap::Parser::try_parse_from`]

	///

	/// To allow running the node without subcommand, it also sets a few more settings:

	/// [`clap::Command::propagate_version`], [`clap::Command::args_conflicts_with_subcommands`],

	/// [`clap::Command::subcommand_negates_reqs`].

	///

	/// Creates `Self` from any iterator over arguments.

	/// Print the error message and quit the program in case of failure.

	///

	/// **NOTE:** This method WILL NOT exit when `--help` or `--version` (or short versions) are

	/// used. It will return a [`clap::Error`], where the [`clap::Error::kind`] is a

	/// [`clap::error::ErrorKind::DisplayHelp`] or [`clap::error::ErrorKind::DisplayVersion`]

	/// respectively. You must call [`clap::Error::exit`] or perform a [`std::process::exit`].

	/// Returns the client ID: `{impl_name}/v{impl_version}`

	/// Only create a Configuration for the command provided in argument

	/// Create a runner for the command provided in argument. This will create a Configuration and

	/// a tokio runtime

	/// Create a runner for the command provided in argument. The `logger_hook` can be used to setup

	/// a custom profiler or update the logger configuration before it is initialized.

	///

	/// Example:

	/// ```

	/// use sc_tracing::{SpanDatum, TraceEvent};

	/// struct TestProfiler;

	///

	/// impl sc_tracing::TraceHandler for TestProfiler {

	///  	fn handle_span(&self, sd: &SpanDatum) {}

	/// 		fn handle_event(&self, _event: &TraceEvent) {}

	/// };

	///

	/// fn logger_hook() -> impl FnOnce(&mut sc_cli::LoggerBuilder, &sc_service::Configuration) -> () {

	/// 	|logger_builder, config| {

	/// 			logger_builder.with_custom_profiling(Box::new(TestProfiler{}));

	/// 	}

	/// }

	/// ```

		// `capture` needs to be called in a tokio context.

		// Also capture them as early as possible.

}