Add setlocale() calls around use of libarchive APIs (#14934, #15377)

The libarchive APIs use nl_langinfo(CODESET) for iconv so they need the
locale to be set for LC_CTYPE.  However, the rest of CMake does not
define any behavior for non-ASCII character classification/conversion so
we do not want to setlocale() globally.  Add a RAII class to save, set,
and restore the locale around calls to libarchive APIs.

Inspired-by: Clinton Stimpson <clinton@elemtech.com>
This commit is contained in:
Brad King 2015-02-06 13:23:07 -05:00
parent 87be2e1427
commit cd408d93fd
4 changed files with 39 additions and 0 deletions

View File

@ -261,6 +261,7 @@ set(SRCS
cmLocalGenerator.cxx cmLocalGenerator.cxx
cmLocalGenerator.h cmLocalGenerator.h
cmLocalUnixMakefileGenerator3.cxx cmLocalUnixMakefileGenerator3.cxx
cmLocale.h
cmMakeDepend.cxx cmMakeDepend.cxx
cmMakeDepend.h cmMakeDepend.h
cmMakefile.cxx cmMakefile.cxx

View File

@ -12,6 +12,7 @@
#include "cmArchiveWrite.h" #include "cmArchiveWrite.h"
#include "cmSystemTools.h" #include "cmSystemTools.h"
#include "cmLocale.h"
#include <cmsys/ios/iostream> #include <cmsys/ios/iostream>
#include <cmsys/Directory.hxx> #include <cmsys/Directory.hxx>
#include <cmsys/FStream.hxx> #include <cmsys/FStream.hxx>
@ -259,6 +260,9 @@ bool cmArchiveWrite::AddFile(const char* file,
} }
const char* out = file + skip; const char* out = file + skip;
cmLocaleRAII localeRAII;
static_cast<void>(localeRAII);
// Meta-data. // Meta-data.
std::string dest = prefix? prefix : ""; std::string dest = prefix? prefix : "";
dest += out; dest += out;

31
Source/cmLocale.h Normal file
View File

@ -0,0 +1,31 @@
/*============================================================================
CMake - Cross Platform Makefile Generator
Copyright 2000-2015 Kitware, Inc., Insight Software Consortium
Distributed under the OSI-approved BSD License (the "License");
see accompanying file Copyright.txt for details.
This software is distributed WITHOUT ANY WARRANTY; without even the
implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the License for more information.
============================================================================*/
#ifndef cmLocale_h
#define cmLocale_h
#include <locale.h>
class cmLocaleRAII
{
const char* OldLocale;
public:
cmLocaleRAII(): OldLocale(setlocale(LC_CTYPE, 0))
{
setlocale(LC_CTYPE, "");
}
~cmLocaleRAII()
{
setlocale(LC_CTYPE, this->OldLocale);
}
};
#endif

View File

@ -28,6 +28,7 @@
#include <cmsys/Encoding.hxx> #include <cmsys/Encoding.hxx>
#if defined(CMAKE_BUILD_WITH_CMAKE) #if defined(CMAKE_BUILD_WITH_CMAKE)
# include "cmArchiveWrite.h" # include "cmArchiveWrite.h"
# include "cmLocale.h"
# include <cm_libarchive.h> # include <cm_libarchive.h>
# include <cmsys/Terminal.h> # include <cmsys/Terminal.h>
#endif #endif
@ -1691,6 +1692,8 @@ long copy_data(struct archive *ar, struct archive *aw)
bool extract_tar(const char* outFileName, bool verbose, bool extract_tar(const char* outFileName, bool verbose,
bool extract) bool extract)
{ {
cmLocaleRAII localeRAII;
static_cast<void>(localeRAII);
struct archive* a = archive_read_new(); struct archive* a = archive_read_new();
struct archive *ext = archive_write_disk_new(); struct archive *ext = archive_write_disk_new();
archive_read_support_compression_all(a); archive_read_support_compression_all(a);