| 148 |
lars |
1 |
<?php
|
|
|
2 |
|
|
|
3 |
/**
|
|
|
4 |
* Hoa
|
|
|
5 |
*
|
|
|
6 |
*
|
|
|
7 |
* @license
|
|
|
8 |
*
|
|
|
9 |
* New BSD License
|
|
|
10 |
*
|
|
|
11 |
* Copyright © 2007-2017, Hoa community. All rights reserved.
|
|
|
12 |
*
|
|
|
13 |
* Redistribution and use in source and binary forms, with or without
|
|
|
14 |
* modification, are permitted provided that the following conditions are met:
|
|
|
15 |
* * Redistributions of source code must retain the above copyright
|
|
|
16 |
* notice, this list of conditions and the following disclaimer.
|
|
|
17 |
* * Redistributions in binary form must reproduce the above copyright
|
|
|
18 |
* notice, this list of conditions and the following disclaimer in the
|
|
|
19 |
* documentation and/or other materials provided with the distribution.
|
|
|
20 |
* * Neither the name of the Hoa nor the names of its contributors may be
|
|
|
21 |
* used to endorse or promote products derived from this software without
|
|
|
22 |
* specific prior written permission.
|
|
|
23 |
*
|
|
|
24 |
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
|
25 |
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
|
26 |
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
|
27 |
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS AND CONTRIBUTORS BE
|
|
|
28 |
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
|
|
29 |
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
|
|
30 |
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
|
|
31 |
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
|
|
32 |
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
|
33 |
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
|
34 |
* POSSIBILITY OF SUCH DAMAGE.
|
|
|
35 |
*/
|
|
|
36 |
|
|
|
37 |
namespace Psy\Readline\Hoa;
|
|
|
38 |
|
|
|
39 |
/**
|
|
|
40 |
* Interface \Hoa\Stream\IStream\In.
|
|
|
41 |
*
|
|
|
42 |
* Interface for input.
|
|
|
43 |
*/
|
|
|
44 |
interface StreamIn extends IStream
|
|
|
45 |
{
|
|
|
46 |
/**
|
|
|
47 |
* Test for end-of-stream.
|
|
|
48 |
*/
|
|
|
49 |
public function eof(): bool;
|
|
|
50 |
|
|
|
51 |
/**
|
|
|
52 |
* Read n characters.
|
|
|
53 |
*/
|
|
|
54 |
public function read(int $length);
|
|
|
55 |
|
|
|
56 |
/**
|
|
|
57 |
* Alias of $this->read().
|
|
|
58 |
*/
|
|
|
59 |
public function readString(int $length);
|
|
|
60 |
|
|
|
61 |
/**
|
|
|
62 |
* Read a character.
|
|
|
63 |
* It could be equivalent to $this->read(1).
|
|
|
64 |
*/
|
|
|
65 |
public function readCharacter();
|
|
|
66 |
|
|
|
67 |
/**
|
|
|
68 |
* Read a boolean.
|
|
|
69 |
*/
|
|
|
70 |
public function readBoolean();
|
|
|
71 |
|
|
|
72 |
/**
|
|
|
73 |
* Read an integer.
|
|
|
74 |
*/
|
|
|
75 |
public function readInteger(int $length = 1);
|
|
|
76 |
|
|
|
77 |
/**
|
|
|
78 |
* Read a float.
|
|
|
79 |
*/
|
|
|
80 |
public function readFloat(int $length = 1);
|
|
|
81 |
|
|
|
82 |
/**
|
|
|
83 |
* Read an array.
|
|
|
84 |
* In most cases, it could be an alias to the $this->scanf() method.
|
|
|
85 |
*/
|
|
|
86 |
public function readArray();
|
|
|
87 |
|
|
|
88 |
/**
|
|
|
89 |
* Read a line.
|
|
|
90 |
*/
|
|
|
91 |
public function readLine();
|
|
|
92 |
|
|
|
93 |
/**
|
|
|
94 |
* Read all, i.e. read as much as possible.
|
|
|
95 |
*/
|
|
|
96 |
public function readAll(int $offset = 0);
|
|
|
97 |
|
|
|
98 |
/**
|
|
|
99 |
* Parse input from a stream according to a format.
|
|
|
100 |
*/
|
|
|
101 |
public function scanf(string $format): array;
|
|
|
102 |
}
|