src/util.h

// Copyright 2011 Google Inc. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#ifndef NINJA_UTIL_H_
#define NINJA_UTIL_H_

#ifdef _WIN32
#include <windows.h>
#undef ERROR
#undef max
#undef min
#include "win32port.h"
#else
#include <stdint.h>
#endif

#include <stdarg.h>

#include <string>
#include <vector>

#if !defined(__has_cpp_attribute)
#  define __has_cpp_attribute(x)  0
#endif

#if __has_cpp_attribute(noreturn)
#  define NORETURN [[noreturn]]
#else
#  define NORETURN  // nothing for old compilers
#endif

/// Log a fatal message and exit.
NORETURN void Fatal(const char* msg, ...);

// Have a generic fall-through for different versions of C/C++.
#if __has_cpp_attribute(fallthrough)
#  define NINJA_FALLTHROUGH [[fallthrough]]
#elif defined(__clang__)
#  define NINJA_FALLTHROUGH [[clang::fallthrough]]
#else
#  define NINJA_FALLTHROUGH // nothing
#endif

/// Log a warning message.
void Warning(const char* msg, ...);
void Warning(const char* msg, va_list ap);

/// Log an error message.
void Error(const char* msg, ...);
void Error(const char* msg, va_list ap);

/// Log an informational message.
void Info(const char* msg, ...);
void Info(const char* msg, va_list ap);

/// Format a string.
std::string StringFormat(const char* fmt, ...);
std::string StringFormat(const char* fmt, va_list ap);
void StringAppendFormat(std::string& str, const char* fmt, ...);
void StringAppendFormat(std::string& str, const char* fmt, va_list ap);

/// Canonicalize a path like "foo/../bar.h" into just "bar.h".
/// |slash_bits| has bits set starting from lowest for a backslash that was
/// normalized to a forward slash. (only used on Windows)
void CanonicalizePath(std::string* path, uint64_t* slash_bits);
void CanonicalizePath(char* path, size_t* len, uint64_t* slash_bits);

/// Appends |input| to |*result|, escaping according to the whims of either
/// Bash, or Win32's CommandLineToArgvW().
/// Appends the string directly to |result| without modification if we can
/// determine that it contains no problematic characters.
void GetShellEscapedString(const std::string& input, std::string* result);
void GetWin32EscapedString(const std::string& input, std::string* result);

/// Read a file to a string (in text mode: with CRLF conversion
/// on Windows).
/// Returns -errno and fills in \a err on error.
int ReadFile(const std::string& path, std::string* contents, std::string* err);

/// Get the timestamp of a given file. On success return a positive timestamp
/// in nanoseconds, or 0 if the file is missing. Otherwise, in case of failure,
/// return -1 after setting |*error|.
int64_t GetFileTimestamp(const std::string& path, std::string* error);

#ifdef _WIN32
/// Convert a Win32 FILETIME value into a TimeStamp value.
int64_t TimeStampFromFileTime(const FILETIME& filetime);
#endif  // _WIN32

/// Mark a file descriptor to not be inherited on exec()s.
void SetCloseOnExec(int fd);

/// Given a misspelled string and a list of correct spellings, returns
/// the closest match or NULL if there is no close enough match.
const char* SpellcheckStringV(const std::string& text,
                              const std::vector<const char*>& words);

/// Like SpellcheckStringV, but takes a NULL-terminated list.
const char* SpellcheckString(const char* text, ...);

bool islatinalpha(int c);

/// Removes all Ansi escape codes (http://www.termsys.demon.co.uk/vtansi.htm).
std::string StripAnsiEscapeCodes(const std::string& in);

/// @return the number of processors on the machine.  Useful for an initial
/// guess for how many jobs to run in parallel.  @return 0 on error.
int GetProcessorCount();

/// @return the load average of the machine. A negative value is returned
/// on error.
double GetLoadAverage();

/// Truncates a file to the given size.
bool Truncate(const std::string& path, size_t size, std::string* err);

/// Return true if |path| is absolute for the current platform.
/// On Win32, this recognizes both / and \\ as directory separators.
bool IsAbsolutePath(const std::string& path);

/// Return absolute path of current directory.
/// NOTE: GetCurrentDirectory() is a macro in Win32.
std::string GetCurrentDir();

/// Return absolute path of current executable.
std::string GetCurrentExecutable();

/// Return absolute path of current executable's directory.
std::string GetCurrentExecutableDir();

#ifdef _MSC_VER
#define snprintf _snprintf
#define fileno _fileno
#define unlink _unlink
#define chdir _chdir
#define strtoull _strtoui64
#define getcwd _getcwd
#define PATH_MAX _MAX_PATH
#endif

#ifdef _WIN32
/// Convert the value returned by GetLastError() into a string.
std::string GetLastErrorString();
std::string GetLastErrorString(unsigned error);

/// Calls Fatal() with a function name and GetLastErrorString.
NORETURN void Win32Fatal(const char* function, const char* hint = NULL);
NORETURN void Win32Fatal(const char* function, unsigned long error,
                         const char* hint = NULL);

/// Convert Win32 unicode string into UTF8 string.
std::string ConvertFromUnicodeString(const wchar_t* str, size_t size);
std::string ConvertFromUnicodeString(const std::wstring& str);

/// Convert UTF8 string to a Win32  unicode string.
std::wstring ConvertToUnicodeString(const char* str, size_t size);
std::wstring ConvertToUnicodeString(const std::string& str);

/// Return true if long paths are enabled on this machine
bool AreWin32LongPathsEnabled();

#endif  // !_WIN32

NORETURN void ErrnoFatal(const char* function, const char* hint = NULL);
NORETURN void ErrnoFatal(const char* function, int errnum, const char* hint = NULL);

/// Convert a duration in milliseconds into a human-readable string.
void AppendStringFormatDurationMs(std::string& out, int64_t duration_ms);
std::string StringFormatDurationMs(int64_t duration_ms);

#endif  // NINJA_UTIL_H_