FilterAlphaIndex类 参考

The implementation of the "alphaIndex" filter 更多...

类
struct	ListElem

静态 Public 成员函数
static TemplateVariant	apply (const TemplateVariant &v, const TemplateVariant &args)

静态 Private 成员函数
static QCString	keyToLabel (const char *startLetter)
static std::string	determineSortKey (const TemplateStructIntfPtr s, const QCString &attribName)

详细描述

The implementation of the "alphaIndex" filter

在文件 template.cpp 第 1281 行定义.

成员函数说明

apply()

static TemplateVariant FilterAlphaIndex::apply ( const TemplateVariant &  v, const TemplateVariant &  args  )

inlinestatic

在文件 template.cpp 第 1321 行定义.

    {
      if (v.isList() && args.isString())
      {
        TemplateListIntfPtr list = v.toList();
        if (list)
        {
          //printf("FilterListSort::apply: v=%s args=%s\n",qPrint(v.toString()),qPrint(args.toString()));
          TemplateListIntf::ConstIteratorPtr it = list->createIterator();
 
          TemplateVariant item;
          TemplateListPtr result = TemplateList::alloc();
 
          // create list of items based on v using the data in args as a sort key
          using SortList = std::vector<ListElem>;
          SortList sortList;
          sortList.reserve(v.toList()->count());
          for (it->toFirst();(it->current(item));it->toNext())
          {
            TemplateStructIntfPtr s = item.toStruct();
            if (s)
            {
              std::string sortKey = determineSortKey(s,args.toString());
              sortList.emplace_back(sortKey,item);
              //printf("sortKey=%s\n",qPrint(sortKey));
            }
          }
 
          // sort the list
          std::sort(sortList.begin(),
              sortList.end(),
              [](const auto &lhs,const auto &rhs) { return lhs.key < rhs.key; });
 
          // create an index from the sorted list
          std::string letter;
          TemplateStructPtr indexNode;
          TemplateListPtr indexList;
          for (const auto &elem : sortList)
          {
            if (letter!=elem.key || indexNode==0)
            {
              // create new indexNode
              indexNode = TemplateStruct::alloc();
              indexList = TemplateList::alloc();
              indexNode->set("letter", elem.key);
              indexNode->set("label",  keyToLabel(elem.key.c_str()));
              indexNode->set("items",std::static_pointer_cast<TemplateListIntf>(indexList));
              result->append(std::static_pointer_cast<TemplateStructIntf>(indexNode));
              letter=elem.key;
            }
            indexList->append(elem.value);
          }
          return TemplateVariant(std::static_pointer_cast<TemplateListIntf>(result));
        }
      }
      return v;
    }

引用了 TemplateStruct::alloc(), TemplateList::alloc(), determineSortKey(), TemplateVariant::isList(), TemplateVariant::isString(), keyToLabel(), TemplateVariant::toList(), TemplateVariant::toString() , 以及 TemplateVariant::toStruct().

determineSortKey()

static std::string FilterAlphaIndex::determineSortKey ( const TemplateStructIntfPtr  s, const QCString &  attribName  )

inlinestaticprivate

在文件 template.cpp 第 1313 行定义.

    {
       TemplateVariant v = s->get(attribName);
       int index = getPrefixIndex(v.toString());
       return convertUTF8ToUpper(getUTF8CharAt(v.toString().str(),index));
    }

引用了 convertUTF8ToUpper(), getPrefixIndex(), getUTF8CharAt(), QCString::str() , 以及 TemplateVariant::toString().

被这些函数引用 apply().

keyToLabel()

static QCString FilterAlphaIndex::keyToLabel ( const char *  startLetter )

inlinestaticprivate

在文件 template.cpp 第 1290 行定义.

    {
      //printf(">keyToLabel(%s)\n",qPrint(startLetter));
      const char *p = startLetter;
      char c = *p;
      QCString result;
      if (c<127 && c>31) // printable ASCII character
      {
        result+=c;
      }
      else
      {
        result="0x";
        const char hex[]="0123456789abcdef";
        while ((c=*p++))
        {
          result+=hex[((unsigned char)c)>>4];
          result+=hex[((unsigned char)c)&0xf];
        }
      }
      //printf("<keyToLabel(%s)\n",qPrint(result));
      return result;
    }

引用了 hex.

被这些函数引用 apply().

---

该类的文档由以下文件生成:

• src/template.cpp