X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=blobdiff_plain;f=include%2Fyaz%2Fsortspec.h;h=eb2ccddec5584a900b340cca5dd9371c4158ee98;hp=f6e75375c1a1dad4931dafab78548e05a8c5870f;hb=9b2f4955aee1fcee3702bcd832dbaf7fca7243ad;hpb=8d691989077a0addcbd840d769dce6700f3d9622 diff --git a/include/yaz/sortspec.h b/include/yaz/sortspec.h index f6e7537..eb2ccdd 100644 --- a/include/yaz/sortspec.h +++ b/include/yaz/sortspec.h @@ -1,5 +1,5 @@ -/* - * Copyright (c) 1995-2007, Index Data +/* This file is part of the YAZ toolkit. + * Copyright (C) 1995-2011 Index Data. * All rights reserved. * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met: @@ -24,7 +24,6 @@ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ -/* $Id: sortspec.h,v 1.6 2007-01-03 08:42:14 adam Exp $ */ /** * \file sortspec.h @@ -34,11 +33,54 @@ #define SORTSPEC_H #include -#include +#include +#include YAZ_BEGIN_CDECL -YAZ_EXPORT Z_SortKeySpecList *yaz_sort_spec (ODR out, const char *arg); +/** \brief parse sort spec string + \param odr memory for result + \param arg sort spec string + \returns Z39.50 SortKeySpecList or NULL on error + + The sort spec list is of the form: + (field flags)+ + where field is either a string or one or more attribute pairs + key=value (there must be no blanks in either field of flags). + flags is a character list: + dD> : descending + aA< : ascending (default) + iI : ignoreccase / case-insensitive (default) + sS : respectcase / case-sensitive + ! : abort of key is omitted in result + =value : missing value + + Examples: + + title a + + 1=4 ia 1=1003 sd +*/ +YAZ_EXPORT Z_SortKeySpecList *yaz_sort_spec(ODR odr, const char *arg); + +/* \brief converts SortKeySpecList to CQL sortby string + \param sksl SortKeySpecList + \param w resulting CQL SORTBY string (of string to be appended) + \retval 0 successful + \retval -1 failure +*/ +YAZ_EXPORT int yaz_sort_spec_to_cql(Z_SortKeySpecList *sksl, WRBUF w); + +/* \brief adds PQF type-7 sorting to existing PQF from SortKeySpecList + \param sksl SortKeySpecList + \param w original PQF (without the Type-7) + \retval 0 successful + \retval -1 failure + + If successful, the pqf WRBUF holds the new PQF including the Type-7 + part. +*/ +YAZ_EXPORT int yaz_sort_spec_to_type7(Z_SortKeySpecList *sksl, WRBUF pqf); YAZ_END_CDECL @@ -47,6 +89,7 @@ YAZ_END_CDECL /* * Local variables: * c-basic-offset: 4 + * c-file-style: "Stroustrup" * indent-tabs-mode: nil * End: * vim: shiftwidth=4 tabstop=8 expandtab