xpcom/ds/nsStaticAtom.h
author Ehsan Akhgari <ehsan@mozilla.com>
Sun, 18 Jan 2015 13:57:20 -0500
changeset 251632 aaf1358c797509af733281cd83e4c6de53924344
parent 213985 57038b3a8c97d91bd5a6a947d47e85a8882ec167
child 268263 2328731ef45354daf50eb21607a3c781ab79bc7c
permissions -rw-r--r--
Bug 1123109 - Mark nsStaticAtom::mStringBuffer as non-owning; r=froydnj

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#ifndef nsStaticAtom_h__
#define nsStaticAtom_h__

#include "nsIAtom.h"
#include "nsStringBuffer.h"
#include "prlog.h"

typedef char16_t nsStaticAtomStringType;

#define NS_STATIC_ATOM(buffer_name, atom_ptr)  { (nsStringBuffer*) &buffer_name, atom_ptr }
#define NS_STATIC_ATOM_BUFFER(buffer_name, str_data) static nsFakeStringBuffer< sizeof(str_data) > buffer_name = { 1, sizeof(str_data) * sizeof(nsStaticAtomStringType), MOZ_UTF16(str_data) };

/**
 * Holds data used to initialize large number of atoms during startup. Use
 * the above macros to initialize these structs. They should never be accessed
 * directly other than from AtomTable.cpp
 */
struct nsStaticAtom
{
  // mStringBuffer points to the string buffer for a permanent atom, and is
  // therefore safe as a non-owning reference.
  nsStringBuffer* MOZ_NON_OWNING_REF mStringBuffer;
  nsIAtom** mAtom;
};

/**
 * This is a struct with the same binary layout as a nsStringBuffer.
 */
template<uint32_t size>
struct nsFakeStringBuffer
{
  int32_t mRefCnt;
  uint32_t mSize;
  nsStaticAtomStringType mStringData[size];
};

// Register an array of static atoms with the atom table
template<uint32_t N>
nsresult
NS_RegisterStaticAtoms(const nsStaticAtom (&aAtoms)[N])
{
  extern nsresult RegisterStaticAtoms(const nsStaticAtom*, uint32_t aAtomCount);
  return RegisterStaticAtoms(aAtoms, N);
}

#endif