package shakuhachi

  1. Overview
  2. Docs
A music collection manager

Install

dune-project
 Dependency

Authors

Maintainers

Sources

0.1.0.tar.gz
sha256=bb7f91cc44c09f922d2a614e9e01fd0d2976840bacf839a8b99de63c6fc5b3b8
sha512=f02827db4228b017bb2ad7d64cb1c0667831ec2341e6f759266ec834e40627c2affeace143c6d5e769b3acce63f889b3cbd1a9ca4768091840e8fce1d4750f86

doc/src/shakuhachi.query/substring.ml.html

Source file substring.ml

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
(**********************************************************************************************)
(*                                                                                            *)
(* This file is part of shakuhachi: a music collection manager                                *)
(* Copyright (C) 2025 Yves Ndiaye                                                             *)
(*                                                                                            *)
(* shakuhachi is free software: you can redistribute it and/or modify it under the terms      *)
(* of the GNU General Public License as published by the Free Software Foundation,            *)
(* either version 3 of the License, or (at your option) any later version.                    *)
(*                                                                                            *)
(* shakuhachi is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;    *)
(* without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR           *)
(* PURPOSE.  See the GNU General Public License for more details.                             *)
(* You should have received a copy of the GNU General Public License along with shakuhachi.   *)
(* If not, see <http://www.gnu.org/licenses/>.                                                *)
(*                                                                                            *)
(**********************************************************************************************)

(** Operations on substring node' values *)

(** type of substring node' values *)
type t =
  | STitle
  | SSortName
  | SArtist
  | SAlbum
  | SAlbumArtist
  | SComposer
  | SGenre

(** [assocs] is each substring associated with their key. *)
let assocs =
  [
    (Keys.title, STitle);
    (Keys.sort_name, SSortName);
    (Keys.artist, SArtist);
    (Keys.album, SAlbum);
    (Keys.album_artist, SAlbumArtist);
    (Keys.composer, SComposer);
    (Keys.genre, SGenre);
  ]

(** [to_string substring] is a {!Keys} associated with [substring]. *)
let to_string = function
  | STitle ->
      Keys.title
  | SSortName ->
      Keys.sort_name
  | SArtist ->
      Keys.artist
  | SAlbum ->
      Keys.album
  | SAlbumArtist ->
      Keys.album_artist
  | SComposer ->
      Keys.composer
  | SGenre ->
      Keys.genre

(** [of_string s] tries to parse [s] a key associated with a substring. *)
let of_string t = List.assoc_opt t assocs

(** default list of substring used by {i skhc} when the query.field key in
    configuration file is missing. *)
let default = [ STitle; SSortName; SArtist; SAlbum; SAlbumArtist ]

(** [compare s0 s1] is [Stdlib.compare s0 s1]. *)
let compare : t -> t -> int = Stdlib.compare