mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-11-06 09:05:45 +00:00
135 lines
4.8 KiB
C++
135 lines
4.8 KiB
C++
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
|
/* ***** BEGIN LICENSE BLOCK *****
|
|
* Version: NPL 1.1/GPL 2.0/LGPL 2.1
|
|
*
|
|
* The contents of this file are subject to the Netscape 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/NPL/
|
|
*
|
|
* 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.org code.
|
|
*
|
|
* The Initial Developer of the Original Code is
|
|
* Netscape Communications Corporation.
|
|
* Portions created by the Initial Developer are Copyright (C) 1998
|
|
* the Initial Developer. All Rights Reserved.
|
|
*
|
|
* Contributor(s):
|
|
*
|
|
* 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 NPL, 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 NPL, the GPL or the LGPL.
|
|
*
|
|
* ***** END LICENSE BLOCK ***** */
|
|
|
|
#ifndef _nsMsgKeySet_H_
|
|
#define _nsMsgKeySet_H_
|
|
|
|
#include "msgCore.h"
|
|
|
|
// nsMsgKeySet represents a set of articles. Typically, it is the set of
|
|
// read articles from a .newsrc file, but it can be used for other purposes
|
|
// too.
|
|
|
|
#if 0
|
|
// If a MSG_NewsHost* is supplied to the creation routine, then that
|
|
// MSG_NewsHost will be notified whenever a change is made to set.
|
|
class MSG_NewsHost;
|
|
#endif
|
|
|
|
class NS_MSG_BASE nsMsgKeySet {
|
|
public:
|
|
// Creates an empty set.
|
|
static nsMsgKeySet* Create(/* MSG_NewsHost* host = NULL*/);
|
|
|
|
// Creates a set from the list of numbers, as might be found in a
|
|
// newsrc file.
|
|
static nsMsgKeySet* Create(const char* str/* , MSG_NewsHost* host = NULL*/);
|
|
~nsMsgKeySet();
|
|
|
|
// FirstNonMember() returns the lowest non-member of the set that is
|
|
// greater than 0.
|
|
PRInt32 FirstNonMember();
|
|
|
|
// Output() converts to a string representation suitable for writing to a
|
|
// .newsrc file.
|
|
nsresult Output(char **outputStr);
|
|
|
|
// IsMember() returns whether the given article is a member of this set.
|
|
PRBool IsMember(PRInt32 art);
|
|
|
|
// Add() adds the given article to the set. (Returns 1 if a change was
|
|
// made, 0 if it was already there, and negative on error.)
|
|
int Add(PRInt32 art);
|
|
|
|
// Remove() removes the given article from the set.
|
|
int Remove(PRInt32 art);
|
|
|
|
// AddRange() adds the (inclusive) given range of articles to the set.
|
|
int AddRange(PRInt32 first, PRInt32 last);
|
|
|
|
// CountMissingInRange() takes an inclusive range of articles and returns
|
|
// the number of articles in that range which are not in the set.
|
|
PRInt32 CountMissingInRange(PRInt32 start, PRInt32 end);
|
|
|
|
// FirstMissingRange() takes an inclusive range and finds the first range
|
|
// of articles that are not in the set. If none, return zeros.
|
|
int FirstMissingRange(PRInt32 min, PRInt32 max, PRInt32* first, PRInt32* last);
|
|
|
|
|
|
// LastMissingRange() takes an inclusive range and finds the last range
|
|
// of articles that are not in the set. If none, return zeros.
|
|
int LastMissingRange(PRInt32 min, PRInt32 max, PRInt32* first, PRInt32* last);
|
|
|
|
PRInt32 GetLastMember();
|
|
PRInt32 GetFirstMember();
|
|
void SetLastMember(PRInt32 highWaterMark);
|
|
// For debugging only...
|
|
PRInt32 getLength() {return m_length;}
|
|
|
|
#ifdef DEBUG
|
|
static void RunTests();
|
|
#endif
|
|
|
|
protected:
|
|
nsMsgKeySet(/* MSG_NewsHost* host */);
|
|
nsMsgKeySet(const char* /* , MSG_NewsHost* host */);
|
|
PRBool Grow();
|
|
PRBool Optimize();
|
|
|
|
#ifdef DEBUG
|
|
static void test_decoder(const char*);
|
|
static void test_adder();
|
|
static void test_ranges();
|
|
static void test_member(PRBool with_cache);
|
|
#endif
|
|
|
|
PRInt32 *m_data; /* the numbers composing the `chunks' */
|
|
PRInt32 m_data_size; /* size of that malloc'ed block */
|
|
PRInt32 m_length; /* active area */
|
|
|
|
PRInt32 m_cached_value; /* a potential set member, or -1 if unset*/
|
|
PRInt32 m_cached_value_index; /* the index into `data' at which a search
|
|
to determine whether `cached_value' was
|
|
a member of the set ended. */
|
|
#ifdef NEWSRC_DOES_HOST_STUFF
|
|
MSG_NewsHost* m_host;
|
|
#endif
|
|
};
|
|
|
|
|
|
#endif /* _nsMsgKeySet_H_ */
|