strip.hh

Go to the documentation of this file.
00001 /* vim: set sw=4 sts=4 et foldmethod=syntax : */
00002 
00003 /*
00004  * Copyright (c) 2006, 2007 Ciaran McCreesh
00005  *
00006  * This file is part of the Paludis package manager. Paludis is free software;
00007  * you can redistribute it and/or modify it under the terms of the GNU General
00008  * Public License version 2, as published by the Free Software Foundation.
00009  *
00010  * Paludis is distributed in the hope that it will be useful, but WITHOUT ANY
00011  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
00012  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
00013  * details.
00014  *
00015  * You should have received a copy of the GNU General Public License along with
00016  * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
00017  * Place, Suite 330, Boston, MA  02111-1307  USA
00018  */
00019 
00020 #ifndef PALUDIS_GUARD_PALUDIS_STRIP_HH
00021 #define PALUDIS_GUARD_PALUDIS_STRIP_HH 1
00022 
00023 #include <functional>
00024 #include <string>
00025 #include <paludis/util/attributes.hh>
00026 
00027 /** \file
00028  * Strip functions and adapters.
00029  *
00030  * \ingroup g_strings
00031  *
00032  * \section Examples
00033  *
00034  * - None at this time.
00035  */
00036 
00037 namespace paludis
00038 {
00039     /**
00040      * Return a string equal to s, minus the string remove if remove occurs at
00041      * the start of s.
00042      *
00043      * \ingroup g_strings
00044      */
00045     std::string strip_leading_string(const std::string & s, const std::string & remove) PALUDIS_VISIBLE
00046         PALUDIS_ATTRIBUTE((warn_unused_result));
00047 
00048     /**
00049      * Return a string equal to s minus any leading characters that are
00050      * contained in prefix.
00051      *
00052      * \ingroup g_strings
00053      */
00054     std::string strip_leading(const std::string & s, const std::string & prefix) PALUDIS_VISIBLE
00055         PALUDIS_ATTRIBUTE((warn_unused_result));
00056 
00057     /**
00058      * Return a string equal to s, minus the string remove if remove occurs at
00059      * the end of s.
00060      *
00061      * \ingroup g_strings
00062      */
00063     std::string strip_trailing_string(const std::string & s, const std::string & remove) PALUDIS_VISIBLE
00064         PALUDIS_ATTRIBUTE((warn_unused_result));
00065 
00066     /**
00067      * Return a string equal to s minus any trailing characters that are
00068      * contained in suffix.
00069      *
00070      * \ingroup g_strings
00071      */
00072     std::string strip_trailing(const std::string & s, const std::string & suffix) PALUDIS_VISIBLE
00073         PALUDIS_ATTRIBUTE((warn_unused_result));
00074 }
00075 
00076 #endif

Generated on Mon Sep 21 10:36:08 2009 for paludis by  doxygen 1.5.4