| 1 |
|
%% Copyright (c) 2023 Peter Morgan <peter.james.morgan@gmail.com> |
| 2 |
|
%% |
| 3 |
|
%% Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 |
|
%% you may not use this file except in compliance with the License. |
| 5 |
|
%% You may obtain a copy of the License at |
| 6 |
|
%% |
| 7 |
|
%% http://www.apache.org/licenses/LICENSE-2.0 |
| 8 |
|
%% |
| 9 |
|
%% Unless required by applicable law or agreed to in writing, software |
| 10 |
|
%% distributed under the License is distributed on an "AS IS" BASIS, |
| 11 |
|
%% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 |
|
%% See the License for the specific language governing permissions and |
| 13 |
|
%% limitations under the License. |
| 14 |
|
|
| 15 |
|
|
| 16 |
|
-module(scran). |
| 17 |
|
|
| 18 |
|
|
| 19 |
|
-feature(maybe_expr, enable). |
| 20 |
|
|
| 21 |
|
|
| 22 |
|
-export_type([combiner/0]). |
| 23 |
|
-export_type([input/0]). |
| 24 |
|
-export_type([parser/0]). |
| 25 |
|
-export_type([parser/2]). |
| 26 |
|
-export_type([result/0]). |
| 27 |
|
-export_type([result/2]). |
| 28 |
|
-export_type([with_result/0]). |
| 29 |
|
-include_lib("kernel/include/logger.hrl"). |
| 30 |
|
|
| 31 |
|
|
| 32 |
|
-type input() :: unicode:chardata() |
| 33 |
|
| binary(). |
| 34 |
|
|
| 35 |
|
-type parser() :: parser(input(), result(input(), any())). |
| 36 |
|
|
| 37 |
|
-type parser(I, O) :: fun((I) -> result(I, O)). |
| 38 |
|
|
| 39 |
|
-type result() :: result(input(), input()). |
| 40 |
|
|
| 41 |
|
-type result(I, O) :: {RemainingInput :: I, ProducedOutput :: O} |
| 42 |
|
| none |
| 43 |
|
| nomatch. |
| 44 |
|
|
| 45 |
|
-type with_result() :: fun ((any()) -> scran:parser()). |
| 46 |
|
|
| 47 |
|
-type combiner() :: fun ((any(), any()) -> scran:result()). |