source: vbox/trunk/src/libs/xpcom18a4/ipc/ipcd/shared/src/ipcIDList.h

/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (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.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is Mozilla IPC.
 *
 * The Initial Developer of the Original Code is
 * Netscape Communications Corporation.
 * Portions created by the Initial Developer are Copyright (C) 2002
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *   Darin Fisher <darin@netscape.com>
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

#ifndef ipcIDList_h__
#define ipcIDList_h__

#include "nsID.h"
#include "ipcList.h"

//-----------------------------------------------------------------------------
// nsID node
//-----------------------------------------------------------------------------

class ipcIDNode
{
public:
    ipcIDNode(const nsID &id)
        : mID(id)
        { }

    const nsID &Value() const { return mID; }

    PRBool Equals(const nsID &id) const { return mID.Equals(id); }

    class ipcIDNode *mNext;
private:
    nsID mID;
};

//-----------------------------------------------------------------------------
// singly-linked list of nsIDs
//-----------------------------------------------------------------------------

class ipcIDList : public ipcList<ipcIDNode>
{
public:
    typedef ipcList<ipcIDNode> Super;

    void Prepend(const nsID &id)
    {
        Super::Prepend(new ipcIDNode(id));
    }

    void Append(const nsID &id)
    {
        Super::Append(new ipcIDNode(id));
    }

    const ipcIDNode *Find(const nsID &id) const
    {
        return FindNode(mHead, id);
    }

    PRBool FindAndDelete(const nsID &id)
    {
        ipcIDNode *node = FindNodeBefore(mHead, id);
        if (node) {
            DeleteAfter(node);
            return PR_TRUE;
        }
        else if (!IsEmpty()) {
            DeleteFirst();
            return PR_TRUE;
        }

        return PR_FALSE;
    }

private:
    static NS_HIDDEN_(ipcIDNode *) FindNode      (ipcIDNode *head, const nsID &id);
    static NS_HIDDEN_(ipcIDNode *) FindNodeBefore(ipcIDNode *head, const nsID &id);
};

#endif // !ipcIDList_h__