CLucene源码剖析(2)

文件：VoidList.h

注释说明：中文注释

代码：

/*------------------------------------------------------------------------------
* Copyright (C) 2003-2006 Ben van Klinken and the CLucene Team
*
* Distributable under the terms of either the Apache License (Version 2.0) or
* the GNU Lesser General Public License, as specified in the COPYING file.
------------------------------------------------------------------------------*/
#ifndef _lucene_util_VoidList_
#define _lucene_util_VoidList_

#if defined(_LUCENE_PRAGMA_ONCE)
# pragma once
#endif

#include "Equators.h"

CL_NS_DEF(util)

 //_base实际上是_kt的容器
 //_valueDeletor是对容器中元素回收的处理方式
 template<typename _kt,typename _base,typename _valueDeletor>
 class __CLList:public _base,LUCENE_BASE {
 private:
  //如果为true，则要调用_valueDeletor::doDelete进行资源回收
  bool dv;
  typedef _base base;
 public:
        DEFINE_MUTEX(THIS_LOCK)

  typedef typename _base::const_iterator const_iterator;
  typedef typename _base::iterator iterator;

  virtual ~__CLList(){
   clear();
  }

  __CLList ( const bool deleteValue ):
   dv(deleteValue)
  {
  }
  //是否需要回收
  void setDoDelete(bool val){ dv=val; }

  //sets array to the contents of this array.
  //array must be size+1, otherwise memory may be overwritten
  //把内容转换成数组
  void toArray(_kt* into) const{
   int i=0;
   for ( const_iterator itr=base::begin();itr!=base::end();itr++ ){
    into[i] = *itr;
    i++;
   }
   into[i] = NULL;
  }

  //设定容器的第i个元素
  void set(int32_t i, _kt val) {
   if ( dv )
    _valueDeletor::doDelete((*this)[i]);
   (*this)[i] = val;
  }

  //todo: check this
  //删除最后一个元素
  void delete_back(){
   if ( base::size() > 0 ){
    iterator itr = base::end();
    if ( itr != base::begin())
     itr --;
    _kt key = *itr;
    base::erase(itr);
    if ( dv )
     _valueDeletor::doDelete(key);
   }
  }
  //删除第一个元素
  void delete_front(){
   if ( base::size() > 0 ){
    iterator itr = base::begin();
    _kt key = *itr;
    base::erase(itr);
    if ( dv )
     _valueDeletor::doDelete(key);
   }
  }

  //回收所有元素
  void clear(){
   if ( dv ){
    iterator itr = base::begin();
    while ( itr != base::end() ){
     _valueDeletor::doDelete(*itr);
     itr++;
    }
   }
   //容器clear
   base::clear();
  }

  //从容器中删除某个特定位置的元素，  
  void remove(int32_t i, bool dontDelete=false){
   iterator itr=base::begin();
   //迭代器+操作表明是顺序容器
   itr+=i;
   _kt key = *itr;
   base::erase( itr );
   if ( dv && !dontDelete )
    _valueDeletor::doDelete(key);
  }
  //同上，不过此处指定删除迭代器所指元素
  void remove(iterator itr, bool dontDelete=false){
   _kt key = *itr;
   base::erase( itr );
   if ( dv && !dontDelete )
    _valueDeletor::doDelete(key);
  }

 };

//growable arrays of Objects (like a collection or list)
//a list, so can contain duplicates
//it grows in chunks... todo: check jlucene for initial size of array, and growfactors
//表明__CLList中的容器是vector
template<typename _kt, typename _valueDeletor=CL_NS(util)::Deletor::Dummy>
class CLVector:public __CLList<_kt, CL_NS_STD(vector)<_kt> , _valueDeletor>
{
public:
 CLVector ( const bool deleteValue=true ):
   //构造函数
   __CLList<_kt, CL_NS_STD(vector)<_kt> , _valueDeletor>(deleteValue)
 {
 }
};

//An array-backed implementation of the List interface
//a list, so can contain duplicates
//*** a very simple list - use <valarray>
//(This class is roughly equivalent to Vector, except that it is unsynchronized.)
#define CLArrayList CLVector
#define CLHashSet CLHashList

//implementation of the List interface, provides access to the first and last list elements in O(1)
//no comparator is required... and so can contain duplicates
//a simple list with no comparator
//*** a very simple list - use <list>
#ifdef LUCENE_DISABLE_HASHING
   #define CLHashList CLSetList
#else

//表明__CLList中的容器是hash_set（非标准库）
template<typename _kt,
 typename _Comparator=CL_NS(util)::Compare::TChar,
 typename _valueDeletor=CL_NS(util)::Deletor::Dummy>
class CLHashList:public __CLList<_kt, CL_NS_HASHING(hash_set)<_kt,_Comparator> , _valueDeletor>
{
public:
 CLHashList ( const bool deleteValue=true ):
   __CLList<_kt, CL_NS_HASHING(hash_set)<_kt,_Comparator> , _valueDeletor>(deleteValue)
 {
 }
};
#endif

//表明__CLList中的容器是list
template<typename _kt, typename _valueDeletor=CL_NS(util)::Deletor::Dummy>
class CLLinkedList:public __CLList<_kt, CL_NS_STD(list)<_kt> , _valueDeletor>
{
public:
 CLLinkedList ( const bool deleteValue=true ):
   __CLList<_kt, CL_NS_STD(list)<_kt> , _valueDeletor>(deleteValue)
 {
 }
};

//表明__CLList中的容器是set
template<typename _kt,
 typename _Comparator=CL_NS(util)::Compare::TChar,
 typename _valueDeletor=CL_NS(util)::Deletor::Dummy>
class CLSetList:public __CLList<_kt, CL_NS_STD(set)<_kt,_Comparator> , _valueDeletor>
{
public:
 CLSetList ( const bool deleteValue=true ):
   __CLList<_kt, CL_NS_STD(set)<_kt,_Comparator> , _valueDeletor>(deleteValue)
 {
 }
};

CL_NS_END
#endif