/* Distributed under the OSI-approved BSD 3-Clause License.  See accompanying
   file Copyright.txt or https://cmake.org/licensing for details.  */
#ifndef cmOutputConverter_h
#define cmOutputConverter_h

#include "cmConfigure.h"  // IWYU pragma: keep

#include <string>

#include "cmStateSnapshot.h"

class cmState;
class cmStateDirectory;

class cmOutputConverter
{
public:
    cmOutputConverter(cmStateSnapshot const& snapshot);

    enum OutputFormat
    {
        SHELL,
        WATCOMQUOTE,
        RESPONSE
    };
    std::string ConvertToOutputFormat(const std::string& source,
                                      OutputFormat       output) const;
    std::string ConvertDirectorySeparatorsForShell(
        const std::string& source) const;

    ///! for existing files convert to output path and short path if spaces
    std::string ConvertToOutputForExisting(const std::string& remote,
                                           OutputFormat format = SHELL) const;

    void SetLinkScriptShell(bool linkScriptShell);

    /**
     * Flags to pass to Shell_GetArgument.  These modify the generated
     * quoting and escape sequences to work under alternative
     * environments.
     */
    enum Shell_Flag_e
    {
        /** The target shell is in a makefile.  */
        Shell_Flag_Make = (1 << 0),

        /** The target shell is in a VS project file.  Do not use with
            Shell_Flag_Make.  */
        Shell_Flag_VSIDE = (1 << 1),

        /** In a windows shell the argument is being passed to "echo".  */
        Shell_Flag_EchoWindows = (1 << 2),

        /** The target shell is in a Watcom WMake makefile.  */
        Shell_Flag_WatcomWMake = (1 << 3),

        /** The target shell is in a MinGW Make makefile.  */
        Shell_Flag_MinGWMake = (1 << 4),

        /** The target shell is in a NMake makefile.  */
        Shell_Flag_NMake = (1 << 5),

        /** Make variable reference syntax $(MAKEVAR) should not be escaped
            to allow a build tool to replace it.  Replacement values
            containing spaces, quotes, backslashes, or other
            non-alphanumeric characters that have significance to some makes
            or shells produce undefined behavior.  */
        Shell_Flag_AllowMakeVariables = (1 << 6),

        /** The target shell quoting uses extra single Quotes for Watcom tools.
         */
        Shell_Flag_WatcomQuote = (1 << 7),

        Shell_Flag_IsUnix = (1 << 8)
    };

    std::string EscapeForShell(const std::string& str, bool makeVars = false,
                               bool forEcho        = false,
                               bool useWatcomQuote = false) const;

    static std::string EscapeForCMake(const std::string& str);

    /** Compute an escaped version of the given argument for use in a
        windows shell.  */
    static std::string EscapeWindowsShellArgument(const char* arg,
                                                  int         shell_flags);

    enum FortranFormat
    {
        FortranFormatNone,
        FortranFormatFixed,
        FortranFormatFree
    };
    static FortranFormat GetFortranFormat(const char* value);

    static bool ContainedInDirectory(std::string const&      local_path,
                                     std::string const&      remote_path,
                                     cmStateDirectory const& directory);

    /**
     * Convert the given remote path to a relative path with respect to
     * the given local path.  Both paths must use forward slashes and not
     * already be escaped or quoted.
     * The conversion is skipped if the paths are not both in the source
     * or both in the binary tree.
     */
    std::string ConvertToRelativePath(std::string const& local_path,
                                      std::string const& remote_path) const;

    /**
     * Convert the given remote path to a relative path with respect to
     * the given local path.  Both paths must use forward slashes and not
     * already be escaped or quoted.
     */
    static std::string ForceToRelativePath(std::string const& local_path,
                                           std::string const& remote_path);

private:
    cmState* GetState() const;

    static int         Shell__CharNeedsQuotes(char c, int flags);
    static const char* Shell__SkipMakeVariables(const char* c);
    static int         Shell__ArgumentNeedsQuotes(const char* in, int flags);
    static std::string Shell__GetArgument(const char* in, int flags);

private:
    cmStateSnapshot StateSnapshot;

    bool LinkScriptShell;
};

#endif
