wex v24.10.0
Public Types | Public Member Functions | List of all members
wex::factory::beautify Class Reference

Offers functionality to beautify source code. More...

#include <wex/factory/beautify.h>

Inheritance diagram for wex::factory::beautify:
Inheritance graph
[legend]

Public Types

enum  beautify_t { CMAKE , SOURCE , UNKNOWN }
 The supported beautify types. More...
 

Public Member Functions

 beautify (beautify_t=UNKNOWN)
 Default constructor, specify the beautify type.
 
 beautify (const path &p)
 Constructor, the path is used to set the beautify type.
 
bool check (const path &p)
 Checks if a beautifier exists for specified path and sets type if so.
 
bool file (const path &p) const
 Beautifies the specified file (the auto beautifier should explicitly be enabled).
 
bool is_active () const
 Returns true if beautifier is set non-empty in the config.
 
bool is_auto () const
 Returns true if auto beautifier is set in the config.
 
bool is_supported (const path &p) const
 Returns true if specified path can be beautified.
 
config::strings_t list () const
 Returns default beautifiers.
 
const std::string name () const
 Returns the actual beautifier, or empty string if none selected.
 
beautify_t type () const
 Returns the beautify type.
 

Detailed Description

Offers functionality to beautify source code.

Member Enumeration Documentation

◆ beautify_t

The supported beautify types.

Enumerator
CMAKE 

cmake

SOURCE 

source code (c, c#)

UNKNOWN 

type will be set later on

Member Function Documentation

◆ file()

bool wex::factory::beautify::file ( const path & p) const

Beautifies the specified file (the auto beautifier should explicitly be enabled).

Return false if it did not succeed.