Files
swift-mirror/include/swift/Basic/QuotedString.h
2015-12-31 23:28:40 +00:00

47 lines
1.4 KiB
C++

//===- QuotedString.h - Print a string in double-quotes ---------*- C++ -*-===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2016 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See http://swift.org/LICENSE.txt for license information
// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//
//
/// \file Declares QuotedString, a convenient type for printing a
/// string as a string literal.
//
//===----------------------------------------------------------------------===//
#ifndef SWIFT_BASIC_QUOTEDSTRING_H
#define SWIFT_BASIC_QUOTEDSTRING_H
#include "llvm/ADT/StringRef.h"
namespace llvm {
class raw_ostream;
}
namespace swift {
/// Print the given string as if it were a quoted string.
void printAsQuotedString(llvm::raw_ostream &out, llvm::StringRef text);
/// A class designed to make it easy to write a string to a stream
/// as a quoted string.
class QuotedString {
llvm::StringRef Text;
public:
explicit QuotedString(llvm::StringRef text) : Text(text) {}
friend llvm::raw_ostream &operator<<(llvm::raw_ostream &out,
QuotedString string) {
printAsQuotedString(out, string.Text);
return out;
}
};
}
#endif