main_check.hpp File Reference

#include <iostream>
#include <string>
#include <vector>
#include "main_stack.hpp"

Include dependency graph for main_check.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	engine::CheckOptions

Functions
void	engine::check_stack (const cloe::StackOptions &opt, const std::vector< std::string > &files, bool *ok=nullptr)
std::string	engine::check_summary (const CheckOptions &opt, const std::vector< std::string > &files, bool *ok=nullptr)
cloe::Json	engine::check_json (const CheckOptions &opt, const std::vector< std::string > &files, bool *ok=nullptr)
int	engine::check_merged (const CheckOptions &opt, const std::vector< std::string > &filepaths)
int	engine::check_distinct (const CheckOptions &opt, const std::vector< std::string > &filepaths)
int	engine::check (const CheckOptions &opt, const std::vector< std::string > &filepaths)

Detailed Description

See also

main.cpp

This file contains the "check" options and command.

Function Documentation

check_json()

cloe::Json engine::check_json ( const CheckOptions &  opt, const std::vector< std::string > &  files, bool *  ok = nullptr  )

inline

Output a JSON value of its state, with null returned for ok, and an error object for each error.

Here is the call graph for this function:

Here is the caller graph for this function:

check_stack()

void engine::check_stack ( const cloe::StackOptions &  opt, const std::vector< std::string > &  files, bool *  ok = nullptr  )

inline

Output nothing in the case that a file is valid, and an error message if there is a problem.

This mirrors most closely the standard unix command-line philosophy.

Here is the call graph for this function:

Here is the caller graph for this function:

check_summary()

std::string engine::check_summary ( const CheckOptions &  opt, const std::vector< std::string > &  files, bool *  ok = nullptr  )

inline

Output a summary of its state, ranging from OK to FATAL.

This is useful for those who want a definitive answer for the input.

Here is the call graph for this function:

Here is the caller graph for this function: