sbStringBundle.h

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set sw=2 :miv */
/*
//
// BEGIN SONGBIRD GPL
//
// This file is part of the Songbird web player.
//
// Copyright(c) 2005-2008 POTI, Inc.
// http://songbirdnest.com
//
// This file may be licensed under the terms of of the
// GNU General Public License Version 2 (the "GPL").
//
// Software distributed under the License is distributed
// on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either
// express or implied. See the GPL for the specific language
// governing rights and limitations.
//
// You should have received a copy of the GPL along with this
// program. If not, go to http://www.gnu.org/licenses/gpl.html
// or write to the Free Software Foundation, Inc.,
// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
//
// END SONGBIRD GPL
//
*/

#ifndef __SB_STRINGBUNDLE_H__
#define __SB_STRINGBUNDLE_H__

//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
//
// Songbird string bundle services.
//
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------

// Songbird imports.
#include <sbIStringBundleService.h>
#include <sbStringUtils.h>

// Mozilla imports.
#include <nsCOMArray.h>
#include <nsCOMPtr.h>
#include <nsIStringBundle.h>


class sbStringBundle
{
  //----------------------------------------------------------------------------
  //
  // Public interface.
  //
  //----------------------------------------------------------------------------

public:

  //
  // Constructors/destructors.
  //

  sbStringBundle(const char* aURI = nsnull);


  sbStringBundle(nsIStringBundle* aBundle);


  //
  // Public services.
  //

  nsString Get(const nsAString& aKey,
               const nsAString& aDefault = SBVoidString());

  nsString Get(const char* aKey,
               const char* aDefault = nsnull);


  nsString Format(const nsAString&    aKey,
                  nsTArray<nsString>& aParams,
                  const nsAString&    aDefault = SBVoidString());

  nsString Format(const char*         aKey,
                  nsTArray<nsString>& aParams,
                  const char*         aDefault = nsnull);

  nsString Format(const nsAString&    aKey,
                  const nsAString&    aParam,
                  const nsAString&    aDefault = SBVoidString());

  nsString Format(const char*         aKey,
                  const nsAString&    aParam,
                  const char*         aDefault = nsnull);


  //----------------------------------------------------------------------------
  //
  // Private interface.
  //
  //----------------------------------------------------------------------------

private:

  //
  // mStringBundleService       Songbird string bundle service.
  // mBundleList                List of string bundles.
  //

  nsCOMPtr<sbIStringBundleService>
                                mStringBundleService;
  nsCOMArray<nsIStringBundle>   mBundleList;


  //
  // Internal services.
  //

  nsresult LoadBundle(const char* aURI);

  nsresult LoadBundle(nsIStringBundle* aBundle);

  nsresult ApplySubstitutions(nsAString& aString);
};


#endif // __SB_STRINGBUNDLE_H__