Saves the UTF8‐encoded contents string into the file FileName using a specific encoding.

Synopsis

Declared in <llvm/Support/Program.h>

std::error_code
writeFileWithEncoding(
    StringRef FileName,
    StringRef Contents,
    WindowsEncodingMethod Encoding = WEM_UTF8);

Description

This write file function adds the possibility to choose which encoding to use when writing a text file. On Windows, this is important when writing files with internationalization support with an encoding that is different from the one used in LLVM (UTF‐8). We use this when writing response files, since GCC tools on MinGW only understand legacy code pages, and VisualStudio tools only understand UTF‐16. For UNIX, using different encodings is silently ignored, since all tools work well with UTF‐8. This function assumes that you only use UTF‐8 text data and will convert it to your desired encoding before writing to the file.

FIXME: We use EM_CurrentCodePage to write response files for GNU tools in a MinGW/MinGW‐w64 environment, which has serious flaws but currently is our best shot to make gcc/ld understand international characters. This should be changed as soon as binutils fix this to support UTF16 on mingw.

Return Value

non‐zero error_code if failed

Parameters

Name

Description

FileName

Path of the file to write.

Contents

UTF‐8 text to encode and write.

Encoding

Encoding to apply on Windows (ignored on UNIX).

Created with MrDocs