bdlb_literalutil.h

Go to the documentation of this file.

/// @file bdlb_literalutil.h
///
/// The content of this file has been pre-processed for Doxygen.
///
 
 
// bdlb_literalutil.h                                                 -*-C++-*-
#ifndef INCLUDED_BDLB_LITERALUTIL
#define INCLUDED_BDLB_LITERALUTIL
 
#include <bsls_ident.h>
BSLS_IDENT("$Id: $")
 
/// @defgroup bdlb_literalutil bdlb_literalutil
/// @brief  Provide utility routines for programming language literals.
/// @addtogroup bdl
/// @{
/// @addtogroup bdlb
/// @{
/// @addtogroup bdlb_literalutil
/// @{
///
/// <h1> Outline </h1>
/// * <a href="#bdlb_literalutil-purpose"> Purpose</a>
/// * <a href="#bdlb_literalutil-classes"> Classes </a>
/// * <a href="#bdlb_literalutil-description"> Description </a>
///
/// # Purpose {#bdlb_literalutil-purpose}
/// Provide utility routines for programming language literals.
///
/// # Classes {#bdlb_literalutil-classes}
///
/// -  bdlb::LiteralUtil: utilities namespace for programming language literals
///
/// @see  hslc_lexer, hslc_parser
///
/// # Description {#bdlb_literalutil-description}
/// This component provides a namespace, `bdlb::LiteralUtil`, for a
/// set of utility routines that operate on (programming language) literals.
/// @}
/** @} */
/** @} */
 
/** @addtogroup bdl
 * @{
 */
/** @addtogroup bdlb
 * @{
 */
/** @addtogroup bdlb_literalutil
 * @{
 */
 
#include <bdlscm_version.h>
 
#include <bsls_libraryfeatures.h>
 
#include <bsl_string.h>
#include <bsl_string_view.h>
 
#include <string>           // 'std::string', 'std::pmr::string'
 
 
namespace bdlb {
 
                             // ==================
                             // struct LiteralUtil
                             // ==================
 
struct LiteralUtil {
  private:
    // PRIVATE CLASS METHODS
 
    /// Load into the specified `result` string the `"` delimited and
    /// escaped C/C++ string literal equivalent representing the same value
    /// as that of the specified `input` string.  When the C string literal
    /// equivalent is translated by a compiler having C-compatible string
    /// literals, it will result in a string identical to the `input` string.  
    /// 
    /// \note Note that   this code uses the (ASCII) '\' character, rather
    /// than Unicode code points for escapes.
    template <class OUT_STR>
    static void createQuotedEscapedCString_Impl(
                                               OUT_STR                 *result,
                                               const bsl::string_view&  input);
 
  public:
    // CLASS METHODS
 
    /// Load into the specified `result` string the `"` delimited and
    /// escaped C/C++ string literal equivalent representing the same value
    /// as that of the specified `input` string.  When the C string literal
    /// equivalent is translated by a compiler having C-compatible string
    /// literals, it will result in a string identical to the `input` string.  
    /// 
    /// \note Note that   this code uses the (ASCII) '\' character, rather
    /// than Unicode code points for escapes.
    static void createQuotedEscapedCString(bsl::string              *result,
                                           const bsl::string_view&   input);
    static void createQuotedEscapedCString(std::string              *result,
                                           const bsl::string_view&   input);
 
#ifdef BSLS_LIBRARYFEATURES_HAS_CPP17_PMR_STRING
    /// Load into the specified `result` string the `"` delimited and
    /// escaped C/C++ string literal equivalent representing the same value
    /// as that of the specified `input` string.  When the C string literal
    /// equivalent is translated by a compiler having C-compatible string
    /// literals, it will result in a string identical to the `input` string.  
    /// 
    /// \note Note that   this code uses the (ASCII) '\' character, rather
    /// than Unicode code points for escapes.
    static void createQuotedEscapedCString(std::pmr::string         *result,
                                           const bsl::string_view&   input);
#endif
};
 
}  // close package namespace
 
 
#endif
 
// ----------------------------------------------------------------------------
// Copyright 2020 Bloomberg Finance L.P.
//
// 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.
// ----------------------------- END-OF-FILE ----------------------------------
 
/** @} */
/** @} */
/** @} */