├── .gitignore ├── Cargo.toml ├── LICENSE-MPL2 ├── README.md ├── examples ├── echo.rs └── readline.rs └── src ├── .lib.rs.rustfmt ├── lib.rs └── raw.rs /.gitignore: -------------------------------------------------------------------------------- 1 | target 2 | Cargo.lock 3 | -------------------------------------------------------------------------------- /Cargo.toml: -------------------------------------------------------------------------------- 1 | [package] 2 | name = "async-readline" 3 | version = "0.1.0" 4 | authors = ["Dawid Ciężarkiewicz "] 5 | license = "MPL-2.0" 6 | readme = "README.md" 7 | 8 | [dependencies] 9 | mio = "0.6.1" 10 | futures = "0.1.6" 11 | tokio = "0.0.0" 12 | tokio-core = "0.1.1" 13 | libc = "0.2.18" 14 | nix = "0.7.0" 15 | termios = "0.2.2" 16 | -------------------------------------------------------------------------------- /LICENSE-MPL2: -------------------------------------------------------------------------------- 1 | Mozilla Public License Version 2.0 2 | ================================== 3 | 4 | 1. Definitions 5 | -------------- 6 | 7 | 1.1. "Contributor" 8 | means each individual or legal entity that creates, contributes to 9 | the creation of, or owns Covered Software. 10 | 11 | 1.2. "Contributor Version" 12 | means the combination of the Contributions of others (if any) used 13 | by a Contributor and that particular Contributor's Contribution. 14 | 15 | 1.3. "Contribution" 16 | means Covered Software of a particular Contributor. 17 | 18 | 1.4. "Covered Software" 19 | means Source Code Form to which the initial Contributor has attached 20 | the notice in Exhibit A, the Executable Form of such Source Code 21 | Form, and Modifications of such Source Code Form, in each case 22 | including portions thereof. 23 | 24 | 1.5. "Incompatible With Secondary Licenses" 25 | means 26 | 27 | (a) that the initial Contributor has attached the notice described 28 | in Exhibit B to the Covered Software; or 29 | 30 | (b) that the Covered Software was made available under the terms of 31 | version 1.1 or earlier of the License, but not also under the 32 | terms of a Secondary License. 33 | 34 | 1.6. "Executable Form" 35 | means any form of the work other than Source Code Form. 36 | 37 | 1.7. "Larger Work" 38 | means a work that combines Covered Software with other material, in 39 | a separate file or files, that is not Covered Software. 40 | 41 | 1.8. "License" 42 | means this document. 43 | 44 | 1.9. "Licensable" 45 | means having the right to grant, to the maximum extent possible, 46 | whether at the time of the initial grant or subsequently, any and 47 | all of the rights conveyed by this License. 48 | 49 | 1.10. "Modifications" 50 | means any of the following: 51 | 52 | (a) any file in Source Code Form that results from an addition to, 53 | deletion from, or modification of the contents of Covered 54 | Software; or 55 | 56 | (b) any new file in Source Code Form that contains any Covered 57 | Software. 58 | 59 | 1.11. "Patent Claims" of a Contributor 60 | means any patent claim(s), including without limitation, method, 61 | process, and apparatus claims, in any patent Licensable by such 62 | Contributor that would be infringed, but for the grant of the 63 | License, by the making, using, selling, offering for sale, having 64 | made, import, or transfer of either its Contributions or its 65 | Contributor Version. 66 | 67 | 1.12. "Secondary License" 68 | means either the GNU General Public License, Version 2.0, the GNU 69 | Lesser General Public License, Version 2.1, the GNU Affero General 70 | Public License, Version 3.0, or any later versions of those 71 | licenses. 72 | 73 | 1.13. "Source Code Form" 74 | means the form of the work preferred for making modifications. 75 | 76 | 1.14. "You" (or "Your") 77 | means an individual or a legal entity exercising rights under this 78 | License. For legal entities, "You" includes any entity that 79 | controls, is controlled by, or is under common control with You. For 80 | purposes of this definition, "control" means (a) the power, direct 81 | or indirect, to cause the direction or management of such entity, 82 | whether by contract or otherwise, or (b) ownership of more than 83 | fifty percent (50%) of the outstanding shares or beneficial 84 | ownership of such entity. 85 | 86 | 2. License Grants and Conditions 87 | -------------------------------- 88 | 89 | 2.1. Grants 90 | 91 | Each Contributor hereby grants You a world-wide, royalty-free, 92 | non-exclusive license: 93 | 94 | (a) under intellectual property rights (other than patent or trademark) 95 | Licensable by such Contributor to use, reproduce, make available, 96 | modify, display, perform, distribute, and otherwise exploit its 97 | Contributions, either on an unmodified basis, with Modifications, or 98 | as part of a Larger Work; and 99 | 100 | (b) under Patent Claims of such Contributor to make, use, sell, offer 101 | for sale, have made, import, and otherwise transfer either its 102 | Contributions or its Contributor Version. 103 | 104 | 2.2. Effective Date 105 | 106 | The licenses granted in Section 2.1 with respect to any Contribution 107 | become effective for each Contribution on the date the Contributor first 108 | distributes such Contribution. 109 | 110 | 2.3. Limitations on Grant Scope 111 | 112 | The licenses granted in this Section 2 are the only rights granted under 113 | this License. No additional rights or licenses will be implied from the 114 | distribution or licensing of Covered Software under this License. 115 | Notwithstanding Section 2.1(b) above, no patent license is granted by a 116 | Contributor: 117 | 118 | (a) for any code that a Contributor has removed from Covered Software; 119 | or 120 | 121 | (b) for infringements caused by: (i) Your and any other third party's 122 | modifications of Covered Software, or (ii) the combination of its 123 | Contributions with other software (except as part of its Contributor 124 | Version); or 125 | 126 | (c) under Patent Claims infringed by Covered Software in the absence of 127 | its Contributions. 128 | 129 | This License does not grant any rights in the trademarks, service marks, 130 | or logos of any Contributor (except as may be necessary to comply with 131 | the notice requirements in Section 3.4). 132 | 133 | 2.4. Subsequent Licenses 134 | 135 | No Contributor makes additional grants as a result of Your choice to 136 | distribute the Covered Software under a subsequent version of this 137 | License (see Section 10.2) or under the terms of a Secondary License (if 138 | permitted under the terms of Section 3.3). 139 | 140 | 2.5. Representation 141 | 142 | Each Contributor represents that the Contributor believes its 143 | Contributions are its original creation(s) or it has sufficient rights 144 | to grant the rights to its Contributions conveyed by this License. 145 | 146 | 2.6. Fair Use 147 | 148 | This License is not intended to limit any rights You have under 149 | applicable copyright doctrines of fair use, fair dealing, or other 150 | equivalents. 151 | 152 | 2.7. Conditions 153 | 154 | Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted 155 | in Section 2.1. 156 | 157 | 3. Responsibilities 158 | ------------------- 159 | 160 | 3.1. Distribution of Source Form 161 | 162 | All distribution of Covered Software in Source Code Form, including any 163 | Modifications that You create or to which You contribute, must be under 164 | the terms of this License. You must inform recipients that the Source 165 | Code Form of the Covered Software is governed by the terms of this 166 | License, and how they can obtain a copy of this License. You may not 167 | attempt to alter or restrict the recipients' rights in the Source Code 168 | Form. 169 | 170 | 3.2. Distribution of Executable Form 171 | 172 | If You distribute Covered Software in Executable Form then: 173 | 174 | (a) such Covered Software must also be made available in Source Code 175 | Form, as described in Section 3.1, and You must inform recipients of 176 | the Executable Form how they can obtain a copy of such Source Code 177 | Form by reasonable means in a timely manner, at a charge no more 178 | than the cost of distribution to the recipient; and 179 | 180 | (b) You may distribute such Executable Form under the terms of this 181 | License, or sublicense it under different terms, provided that the 182 | license for the Executable Form does not attempt to limit or alter 183 | the recipients' rights in the Source Code Form under this License. 184 | 185 | 3.3. Distribution of a Larger Work 186 | 187 | You may create and distribute a Larger Work under terms of Your choice, 188 | provided that You also comply with the requirements of this License for 189 | the Covered Software. If the Larger Work is a combination of Covered 190 | Software with a work governed by one or more Secondary Licenses, and the 191 | Covered Software is not Incompatible With Secondary Licenses, this 192 | License permits You to additionally distribute such Covered Software 193 | under the terms of such Secondary License(s), so that the recipient of 194 | the Larger Work may, at their option, further distribute the Covered 195 | Software under the terms of either this License or such Secondary 196 | License(s). 197 | 198 | 3.4. Notices 199 | 200 | You may not remove or alter the substance of any license notices 201 | (including copyright notices, patent notices, disclaimers of warranty, 202 | or limitations of liability) contained within the Source Code Form of 203 | the Covered Software, except that You may alter any license notices to 204 | the extent required to remedy known factual inaccuracies. 205 | 206 | 3.5. Application of Additional Terms 207 | 208 | You may choose to offer, and to charge a fee for, warranty, support, 209 | indemnity or liability obligations to one or more recipients of Covered 210 | Software. However, You may do so only on Your own behalf, and not on 211 | behalf of any Contributor. You must make it absolutely clear that any 212 | such warranty, support, indemnity, or liability obligation is offered by 213 | You alone, and You hereby agree to indemnify every Contributor for any 214 | liability incurred by such Contributor as a result of warranty, support, 215 | indemnity or liability terms You offer. You may include additional 216 | disclaimers of warranty and limitations of liability specific to any 217 | jurisdiction. 218 | 219 | 4. Inability to Comply Due to Statute or Regulation 220 | --------------------------------------------------- 221 | 222 | If it is impossible for You to comply with any of the terms of this 223 | License with respect to some or all of the Covered Software due to 224 | statute, judicial order, or regulation then You must: (a) comply with 225 | the terms of this License to the maximum extent possible; and (b) 226 | describe the limitations and the code they affect. Such description must 227 | be placed in a text file included with all distributions of the Covered 228 | Software under this License. Except to the extent prohibited by statute 229 | or regulation, such description must be sufficiently detailed for a 230 | recipient of ordinary skill to be able to understand it. 231 | 232 | 5. Termination 233 | -------------- 234 | 235 | 5.1. The rights granted under this License will terminate automatically 236 | if You fail to comply with any of its terms. However, if You become 237 | compliant, then the rights granted under this License from a particular 238 | Contributor are reinstated (a) provisionally, unless and until such 239 | Contributor explicitly and finally terminates Your grants, and (b) on an 240 | ongoing basis, if such Contributor fails to notify You of the 241 | non-compliance by some reasonable means prior to 60 days after You have 242 | come back into compliance. Moreover, Your grants from a particular 243 | Contributor are reinstated on an ongoing basis if such Contributor 244 | notifies You of the non-compliance by some reasonable means, this is the 245 | first time You have received notice of non-compliance with this License 246 | from such Contributor, and You become compliant prior to 30 days after 247 | Your receipt of the notice. 248 | 249 | 5.2. If You initiate litigation against any entity by asserting a patent 250 | infringement claim (excluding declaratory judgment actions, 251 | counter-claims, and cross-claims) alleging that a Contributor Version 252 | directly or indirectly infringes any patent, then the rights granted to 253 | You by any and all Contributors for the Covered Software under Section 254 | 2.1 of this License shall terminate. 255 | 256 | 5.3. In the event of termination under Sections 5.1 or 5.2 above, all 257 | end user license agreements (excluding distributors and resellers) which 258 | have been validly granted by You or Your distributors under this License 259 | prior to termination shall survive termination. 260 | 261 | ************************************************************************ 262 | * * 263 | * 6. Disclaimer of Warranty * 264 | * ------------------------- * 265 | * * 266 | * Covered Software is provided under this License on an "as is" * 267 | * basis, without warranty of any kind, either expressed, implied, or * 268 | * statutory, including, without limitation, warranties that the * 269 | * Covered Software is free of defects, merchantable, fit for a * 270 | * particular purpose or non-infringing. The entire risk as to the * 271 | * quality and performance of the Covered Software is with You. * 272 | * Should any Covered Software prove defective in any respect, You * 273 | * (not any Contributor) assume the cost of any necessary servicing, * 274 | * repair, or correction. This disclaimer of warranty constitutes an * 275 | * essential part of this License. No use of any Covered Software is * 276 | * authorized under this License except under this disclaimer. * 277 | * * 278 | ************************************************************************ 279 | 280 | ************************************************************************ 281 | * * 282 | * 7. Limitation of Liability * 283 | * -------------------------- * 284 | * * 285 | * Under no circumstances and under no legal theory, whether tort * 286 | * (including negligence), contract, or otherwise, shall any * 287 | * Contributor, or anyone who distributes Covered Software as * 288 | * permitted above, be liable to You for any direct, indirect, * 289 | * special, incidental, or consequential damages of any character * 290 | * including, without limitation, damages for lost profits, loss of * 291 | * goodwill, work stoppage, computer failure or malfunction, or any * 292 | * and all other commercial damages or losses, even if such party * 293 | * shall have been informed of the possibility of such damages. This * 294 | * limitation of liability shall not apply to liability for death or * 295 | * personal injury resulting from such party's negligence to the * 296 | * extent applicable law prohibits such limitation. Some * 297 | * jurisdictions do not allow the exclusion or limitation of * 298 | * incidental or consequential damages, so this exclusion and * 299 | * limitation may not apply to You. * 300 | * * 301 | ************************************************************************ 302 | 303 | 8. Litigation 304 | ------------- 305 | 306 | Any litigation relating to this License may be brought only in the 307 | courts of a jurisdiction where the defendant maintains its principal 308 | place of business and such litigation shall be governed by laws of that 309 | jurisdiction, without reference to its conflict-of-law provisions. 310 | Nothing in this Section shall prevent a party's ability to bring 311 | cross-claims or counter-claims. 312 | 313 | 9. Miscellaneous 314 | ---------------- 315 | 316 | This License represents the complete agreement concerning the subject 317 | matter hereof. If any provision of this License is held to be 318 | unenforceable, such provision shall be reformed only to the extent 319 | necessary to make it enforceable. Any law or regulation which provides 320 | that the language of a contract shall be construed against the drafter 321 | shall not be used to construe this License against a Contributor. 322 | 323 | 10. Versions of the License 324 | --------------------------- 325 | 326 | 10.1. New Versions 327 | 328 | Mozilla Foundation is the license steward. Except as provided in Section 329 | 10.3, no one other than the license steward has the right to modify or 330 | publish new versions of this License. Each version will be given a 331 | distinguishing version number. 332 | 333 | 10.2. Effect of New Versions 334 | 335 | You may distribute the Covered Software under the terms of the version 336 | of the License under which You originally received the Covered Software, 337 | or under the terms of any subsequent version published by the license 338 | steward. 339 | 340 | 10.3. Modified Versions 341 | 342 | If you create software not governed by this License, and you want to 343 | create a new license for such software, you may create and use a 344 | modified version of this License if you rename the license and remove 345 | any references to the name of the license steward (except to note that 346 | such modified license differs from this License). 347 | 348 | 10.4. Distributing Source Code Form that is Incompatible With Secondary 349 | Licenses 350 | 351 | If You choose to distribute Source Code Form that is Incompatible With 352 | Secondary Licenses under the terms of this version of the License, the 353 | notice described in Exhibit B of this License must be attached. 354 | 355 | Exhibit A - Source Code Form License Notice 356 | ------------------------------------------- 357 | 358 | This Source Code Form is subject to the terms of the Mozilla Public 359 | License, v. 2.0. If a copy of the MPL was not distributed with this 360 | file, You can obtain one at http://mozilla.org/MPL/2.0/. 361 | 362 | If it is not possible or desirable to put the notice in a particular 363 | file, then You may include the notice in a location (such as a LICENSE 364 | file in a relevant directory) where a recipient would be likely to look 365 | for such a notice. 366 | 367 | You may add additional accurate notices of copyright ownership. 368 | 369 | Exhibit B - "Incompatible With Secondary Licenses" Notice 370 | --------------------------------------------------------- 371 | 372 | This Source Code Form is "Incompatible With Secondary Licenses", as 373 | defined by the Mozilla Public License, v. 2.0. 374 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # async-readline 2 | 3 | Asynchronous readline-like interface. 4 | 5 | This is a PoC library implementing a CLI interface that supports asynchronous 6 | command editing and terminal output. In other words: user can keep editing the input 7 | while the terminal output can be added at the same time. 8 | 9 | Everything is asynchronous and reactive to stdio. No additional threads are involved. 10 | 11 | It's implemented in Rust, and on top of Rust's futures and tokio library. 12 | 13 | ## Run the demo example: 14 | 15 | ``` 16 | cargo run --example readline 17 | ``` 18 | 19 | And you should see something like this: 20 | 21 | ![async-readline](http://i.imgur.com/nzL3gwz.gif) 22 | -------------------------------------------------------------------------------- /examples/echo.rs: -------------------------------------------------------------------------------- 1 | extern crate futures; 2 | extern crate tokio_core; 3 | extern crate async_readline; 4 | 5 | use futures::stream::Stream; 6 | use tokio_core::io::{Io}; 7 | use tokio_core::reactor::Core; 8 | 9 | use std::io::{self, Write}; 10 | 11 | use tokio_core::io::{Codec, EasyBuf}; 12 | 13 | struct CharCodec; 14 | 15 | impl Codec for CharCodec { 16 | type In = u8; 17 | type Out = String; 18 | 19 | fn decode(&mut self, buf: &mut EasyBuf) -> Result, io::Error> { 20 | if buf.len() == 0 { 21 | return Ok(None) 22 | } 23 | 24 | let ret = buf.as_ref()[0]; 25 | buf.drain_to(1); 26 | Ok(Some(ret)) 27 | } 28 | 29 | fn encode(&mut self, msg: Self::Out, buf: &mut Vec) -> io::Result<()> { 30 | write!(buf, "{}", msg)?; 31 | Ok(()) 32 | } 33 | } 34 | 35 | fn main() { 36 | // Create the event loop that will drive this server 37 | let mut l = Core::new().unwrap(); 38 | let handle = l.handle(); 39 | 40 | let stdio = async_readline::RawStdio::new(&handle).unwrap(); 41 | let (stdin, stdout, _) = stdio.split(); 42 | 43 | let framed_in = stdin.framed(CharCodec); 44 | let framed_out = stdout.framed(CharCodec); 45 | 46 | let done = framed_in 47 | .map(move |ch| { 48 | format!("got: {}\n", ch) 49 | }) 50 | .forward(framed_out); 51 | 52 | l.run(done).unwrap(); 53 | } 54 | -------------------------------------------------------------------------------- /examples/readline.rs: -------------------------------------------------------------------------------- 1 | extern crate futures; 2 | extern crate tokio_core; 3 | extern crate async_readline; 4 | 5 | use futures::stream::Stream; 6 | use tokio_core::reactor::Core; 7 | 8 | use std::io::Write; 9 | 10 | use std::cell::RefCell; 11 | use std::rc::Rc; 12 | 13 | fn main() { 14 | // Create the event loop that will drive this server 15 | let mut l = Core::new().unwrap(); 16 | let handle = l.handle(); 17 | 18 | let periodic_timer1 = tokio_core::reactor::Interval::new(std::time::Duration::from_millis(2500), &handle).unwrap(); 19 | let periodic_timer2 = tokio_core::reactor::Interval::new(std::time::Duration::from_millis(500), &handle).unwrap(); 20 | let stdio = async_readline::RawStdio::new(&handle).unwrap(); 21 | let (stdin, stdout, _) = stdio.split(); 22 | 23 | 24 | let (commands, rl_writer) = async_readline::init(stdin, stdout); 25 | 26 | let acc1 = Rc::new(RefCell::new(0)); 27 | let acc2 = acc1.clone(); 28 | let acc3 = acc1.clone(); 29 | let connected1 = Rc::new(RefCell::new(false)); 30 | let connected2 = connected1.clone(); 31 | let connected3 = connected1.clone(); 32 | 33 | let done = commands 34 | .map(move |line| { 35 | *connected1.borrow_mut() = false; 36 | *acc1.borrow_mut() = 0; 37 | 38 | let mut v = vec!(); 39 | let _ = write!(v, "\n> "); 40 | v.append(&mut line.line.clone()); 41 | v 42 | }) 43 | .select( 44 | periodic_timer1 45 | .map(|_| { 46 | let mut v = vec!(); 47 | if *connected2.borrow() { 48 | *acc2.borrow_mut() += 1; 49 | let _ = write!(v, "\nFiles ready: {} ", *acc2.borrow()); 50 | } 51 | v 52 | }) 53 | ) 54 | .select( 55 | periodic_timer2.map(|_| { 56 | let mut v = vec!(); 57 | if !*connected3.borrow() { 58 | *acc3.borrow_mut() += 1; 59 | if *acc3.borrow() > 3 { 60 | let _ = write!(v, "\nConnected!"); 61 | *acc3.borrow_mut() = 0; 62 | *connected3.borrow_mut() = true; 63 | } else { 64 | let _ = write!(v, "\nConnecting... "); 65 | } 66 | } else if *acc3.borrow() > 10 { 67 | let _ = write!(v, "Disconnecting... "); 68 | *acc3.borrow_mut() = 0; 69 | *connected3.borrow_mut() = false; 70 | } else if *acc3.borrow() > 5 { 71 | let _ = write!(v, "Error... "); 72 | } 73 | 74 | v 75 | }) 76 | ) 77 | .forward(rl_writer); 78 | 79 | l.run(done).unwrap(); 80 | } 81 | -------------------------------------------------------------------------------- /src/.lib.rs.rustfmt: -------------------------------------------------------------------------------- 1 | extern crate mio; 2 | extern crate tokio_core; 3 | extern crate libc; 4 | 5 | use mio::unix::EventedFd; 6 | use tokio_core::reactor::PollEvented; 7 | use std::io; 8 | 9 | 10 | static STDIN_FILENO: libc::c_int = libc::STDIN_FILENO; 11 | static STDOUT_FILENO: libc::c_int = libc::STDOUT_FILENO; 12 | 13 | fn enable_raw_mode(&self) -> Result { 14 | use nix::errno::Errno::ENOTTY; 15 | use nix::sys::termios::{BRKINT, CS8, ECHO, ICANON, ICRNL, IEXTEN, INPCK, ISIG, ISTRIP, 16 | IXON, /* OPOST, */ VMIN, VTIME}; 17 | if !self.stdin_isatty { 18 | try!(Err(nix::Error::from_errno(ENOTTY))); 19 | } 20 | let original_mode = try!(termios::tcgetattr(STDIN_FILENO)); 21 | let mut raw = original_mode; 22 | // disable BREAK interrupt, CR to NL conversion on input, 23 | // input parity check, strip high bit (bit 8), output flow control 24 | raw.c_iflag = raw.c_iflag & !(BRKINT | ICRNL | INPCK | ISTRIP | IXON); 25 | // we don't want raw output, it turns newlines into straight linefeeds 26 | // raw.c_oflag = raw.c_oflag & !(OPOST); // disable all output processing 27 | raw.c_cflag = raw.c_cflag | (CS8); // character-size mark (8 bits) 28 | // disable echoing, canonical mode, extended input processing and signals 29 | raw.c_lflag = raw.c_lflag & !(ECHO | ICANON | IEXTEN | ISIG); 30 | raw.c_cc[VMIN] = 1; // One character-at-a-time input 31 | raw.c_cc[VTIME] = 0; // with blocking read 32 | try!(termios::tcsetattr(STDIN_FILENO, termios::TCSADRAIN, &raw)); 33 | Ok(original_mode) 34 | } 35 | 36 | struct AsyncRawStdio { 37 | io : PollEvented>, 38 | } 39 | 40 | 41 | impl AsyncRawStdio { 42 | 43 | pub fn new(handle : &tokio_core::reactor::Handle) -> io::Result { 44 | let evented_fd = EventedFd(&STDIN_FILENO); 45 | let poll_evented = PollEvented::new(evented_fd, handle)?; 46 | Ok(AsyncRawStdio { 47 | io : poll_evented, 48 | }) 49 | } 50 | } 51 | 52 | #[cfg(test)] 53 | mod tests { 54 | #[test] 55 | fn it_works() { 56 | } 57 | } 58 | -------------------------------------------------------------------------------- /src/lib.rs: -------------------------------------------------------------------------------- 1 | // TODO: http://rachid.koucha.free.fr/tech_corner/pty_pdip.html 2 | 3 | extern crate mio; 4 | #[macro_use] 5 | extern crate tokio_core; 6 | extern crate libc; 7 | extern crate nix; 8 | extern crate termios; 9 | extern crate futures; 10 | 11 | mod raw; 12 | 13 | pub use raw::*; 14 | 15 | use std::io::{self, Read, Write}; 16 | use futures::{Async, AsyncSink}; 17 | 18 | use futures::sync::BiLock; 19 | 20 | pub struct Line { 21 | pub line : Vec, 22 | pub text_last_nl : bool, 23 | } 24 | 25 | struct ReadlineInner { 26 | stdin : raw::PollFd, 27 | stdout : raw::PollFd, 28 | 29 | line : Vec, 30 | 31 | lines_ready : Vec>, 32 | 33 | text_last_nl : bool, 34 | 35 | 36 | wr_pending: Vec, 37 | } 38 | 39 | pub struct Lines { 40 | inner : BiLock, 41 | } 42 | 43 | pub struct Writer { 44 | inner : BiLock, 45 | } 46 | 47 | impl ReadlineInner { 48 | fn clear_line(&mut self) -> io::Result<()> { 49 | write!(self.wr_pending, "\x1b[2K")?; 50 | write!(self.wr_pending, "\x1b[1000D")?; 51 | Ok(()) 52 | } 53 | 54 | fn redraw_line(&mut self) -> io::Result<()> { 55 | write!(self.wr_pending, "\x1b[2K")?; 56 | write!(self.wr_pending, "\x1b[1000D")?; 57 | write!(self.wr_pending, "> {}", String::from_utf8_lossy(&self.line))?; 58 | Ok(()) 59 | } 60 | 61 | fn leave_prompt(&mut self) -> io::Result<()> { 62 | self.clear_line()?; 63 | self.restore_original()?; 64 | if !self.text_last_nl { 65 | write!(self.wr_pending, "\x1b[1B")?; 66 | write!(self.wr_pending, "\x1b[1A")?; 67 | } 68 | Ok(()) 69 | } 70 | 71 | fn enter_prompt(&mut self) -> io::Result<()> { 72 | self.save_original()?; 73 | if !self.text_last_nl { 74 | //write!(self.wr_pending, "\x1b[1E")?; 75 | write!(self.wr_pending, "\n")?; 76 | self.clear_line()?; 77 | } 78 | Ok(()) 79 | } 80 | 81 | fn save_original(&mut self) -> io::Result<()> { 82 | write!(self.wr_pending, "\x1b[s")?; 83 | Ok(()) 84 | } 85 | 86 | fn restore_original(&mut self) -> io::Result<()> { 87 | write!(self.wr_pending, "\x1b[u")?; 88 | Ok(()) 89 | } 90 | 91 | fn wr_pending_flush(&mut self) -> io::Result<()> { 92 | let n = self.stdout.write(&self.wr_pending)?; 93 | self.wr_pending.drain(..n); 94 | self.stdout.flush()?; 95 | Ok(()) 96 | } 97 | 98 | fn handle_char(&mut self, ch : u8) { 99 | match ch { 100 | 13 => self.lines_ready.push(std::mem::replace(&mut self.line, vec![])), 101 | 127 => { 102 | let _ = self.line.pop(); 103 | }, 104 | _ => self.line.push(ch), 105 | } 106 | } 107 | 108 | fn poll_command(&mut self) -> futures::Poll, io::Error> { 109 | let mut tmp_buf = [0u8; 16]; 110 | 111 | loop { 112 | let _ = self.wr_pending_flush(); 113 | 114 | if let Some(line) = self.lines_ready.pop() { 115 | self.clear_line()?; 116 | let _ = self.wr_pending_flush(); 117 | return Ok( 118 | Async::Ready(Some( 119 | Line { 120 | line: line, 121 | text_last_nl: self.text_last_nl 122 | } 123 | )) 124 | ) 125 | } 126 | 127 | // FIXME: 0 means EOF? 128 | let bytes_read = try_nb!(self.stdin.read(&mut tmp_buf)); 129 | 130 | for ch in &tmp_buf[..bytes_read] { 131 | self.handle_char(*ch) 132 | } 133 | 134 | self.redraw_line()?; 135 | } 136 | } 137 | 138 | fn start_write(&mut self, mut item: Vec) -> futures::StartSend, io::Error> { 139 | if item.len() > 0 { 140 | self.leave_prompt()?; 141 | self.text_last_nl = item[item.len() - 1] == 10; 142 | self.wr_pending.append(&mut item); 143 | self.enter_prompt()?; 144 | self.redraw_line()?; 145 | } 146 | Ok(AsyncSink::Ready) 147 | } 148 | 149 | fn poll_write_complete(&mut self) -> futures::Poll<(), io::Error> { 150 | loop { 151 | try_nb!(self.wr_pending_flush()); 152 | 153 | if self.wr_pending.len() == 0 { 154 | return Ok(Async::Ready(())); 155 | } 156 | 157 | } 158 | } 159 | } 160 | 161 | impl futures::Stream for Lines { 162 | type Item = Line; 163 | type Error = io::Error; 164 | 165 | fn poll(&mut self) -> futures::Poll, Self::Error> { 166 | if let Async::Ready(mut guard) = self.inner.poll_lock() { 167 | guard.poll_command() 168 | } else { 169 | Ok(Async::NotReady) 170 | } 171 | 172 | } 173 | } 174 | 175 | impl futures::Sink for Writer { 176 | type SinkItem = Vec; 177 | type SinkError = io::Error; 178 | 179 | fn start_send(&mut self, item: Self::SinkItem) -> futures::StartSend { 180 | if let Async::Ready(mut guard) = self.inner.poll_lock() { 181 | guard.start_write(item) 182 | } else { 183 | Ok(AsyncSink::NotReady(item)) 184 | } 185 | } 186 | 187 | fn poll_complete(&mut self) -> futures::Poll<(), io::Error> { 188 | if let Async::Ready(mut guard) = self.inner.poll_lock() { 189 | guard.poll_write_complete() 190 | } else { 191 | Ok(Async::NotReady) 192 | } 193 | } 194 | } 195 | 196 | pub fn init(stdin : PollFd, stdout : PollFd) -> (Lines, Writer) { 197 | let mut inner = ReadlineInner { 198 | stdin: stdin, 199 | stdout : stdout, 200 | line: vec![], 201 | text_last_nl: true, 202 | wr_pending : vec!(), 203 | lines_ready : vec![], 204 | }; 205 | 206 | let _ = inner.enter_prompt(); 207 | 208 | let (l1, l2) = BiLock::new(inner); 209 | 210 | 211 | 212 | let writer = Writer { inner: l1 }; 213 | let lines = Lines { inner: l2 }; 214 | (lines, writer) 215 | } 216 | 217 | #[cfg(test)] 218 | mod tests { 219 | #[test] 220 | fn it_works() { 221 | } 222 | } 223 | -------------------------------------------------------------------------------- /src/raw.rs: -------------------------------------------------------------------------------- 1 | //! This should be moved to separate crate and API cleaned up 2 | 3 | use libc; 4 | use tokio_core; 5 | use nix; 6 | use mio; 7 | use termios; 8 | 9 | use mio::unix::EventedFd; 10 | use tokio_core::reactor::PollEvented; 11 | use std::io; 12 | 13 | static STDIN_FILENO: libc::c_int = libc::STDIN_FILENO; 14 | static STDOUT_FILENO: libc::c_int = libc::STDOUT_FILENO; 15 | static STDERR_FILENO: libc::c_int = libc::STDERR_FILENO; 16 | 17 | pub type Mode = termios::Termios; 18 | 19 | 20 | pub struct StdioFd(mio::unix::EventedFd<'static>); 21 | 22 | impl StdioFd { 23 | fn stdin() -> Self { 24 | StdioFd(EventedFd(&STDIN_FILENO)).set_nonblocking() 25 | } 26 | fn stdout() -> Self { 27 | StdioFd(EventedFd(&STDOUT_FILENO)).set_nonblocking() 28 | } 29 | fn stderr() -> Self { 30 | StdioFd(EventedFd(&STDERR_FILENO)).set_nonblocking() 31 | } 32 | 33 | fn set_nonblocking(self) -> Self { 34 | use nix::fcntl::{fcntl, FcntlArg, O_NONBLOCK}; 35 | fcntl(*(self.0).0, FcntlArg::F_SETFL(O_NONBLOCK)).expect("fcntl"); 36 | self 37 | } 38 | } 39 | 40 | impl mio::Evented for StdioFd { 41 | fn register(&self, poll: &mio::Poll, token: mio::Token, interest: mio::Ready, opts: mio::PollOpt) -> io::Result<()> { 42 | self.0.register(poll, token, interest, opts) 43 | } 44 | 45 | fn reregister(&self, poll: &mio::Poll, token: mio::Token, interest: mio::Ready, opts: mio::PollOpt) -> io::Result<()> { 46 | self.0.reregister(poll, token, interest, opts) 47 | } 48 | 49 | fn deregister(&self, poll: &mio::Poll) -> io::Result<()> { 50 | self.0.deregister(poll) 51 | } 52 | } 53 | 54 | impl io::Read for StdioFd { 55 | fn read(&mut self, buf: &mut [u8]) -> io::Result { 56 | loop { 57 | match nix::unistd::read(*(self.0).0, buf) { 58 | Err(nix::Error::Sys(nix::errno::EINTR)) => { 59 | // continue 60 | }, 61 | Err(nix::Error::Sys(e)) => return Err(e.into()), 62 | Err(nix::Error::InvalidPath) => return Err(io::Error::new(io::ErrorKind::InvalidData, "invalid path")), 63 | Ok(count) => return Ok(count), 64 | } 65 | } 66 | } 67 | } 68 | 69 | impl io::Write for StdioFd { 70 | fn write(&mut self, buf: &[u8]) -> io::Result { 71 | loop { 72 | match nix::unistd::write(*(self.0).0, buf) { 73 | Err(nix::Error::Sys(nix::errno::EINTR)) => { 74 | // continue 75 | }, 76 | Err(nix::Error::Sys(e)) => return Err(e.into()), 77 | Err(nix::Error::InvalidPath) => return Err(io::Error::new(io::ErrorKind::InvalidData, "invalid path")), 78 | Ok(count) => return Ok(count), 79 | } 80 | } 81 | } 82 | fn flush(&mut self) -> io::Result<()> { 83 | // No buffering, no flushing 84 | Ok(()) 85 | } 86 | } 87 | 88 | pub struct RawStdio { 89 | stdin : PollEvented, 90 | stdout : PollEvented, 91 | stderr : PollEvented, 92 | stdin_isatty : bool, 93 | } 94 | 95 | pub type PollFd = PollEvented; 96 | 97 | impl RawStdio { 98 | 99 | pub fn new(handle : &tokio_core::reactor::Handle) -> io::Result { 100 | let stdin_poll_evented = PollEvented::new(StdioFd::stdin(), handle)?; 101 | let stdout_poll_evented = PollEvented::new(StdioFd::stdout(), handle)?; 102 | let stderr_poll_evented = PollEvented::new(StdioFd::stderr(), handle)?; 103 | let raw_stdio = RawStdio { 104 | stdin : stdin_poll_evented, 105 | stdout : stdout_poll_evented, 106 | stderr : stderr_poll_evented, 107 | stdin_isatty : true, 108 | }; 109 | raw_stdio.enable_raw_mode()?; 110 | Ok(raw_stdio) 111 | } 112 | 113 | fn enable_raw_mode(&self) -> io::Result { 114 | let mut orig_term = termios::Termios::from_fd(STDIN_FILENO)?; 115 | 116 | use nix::errno::Errno::ENOTTY; 117 | use termios::{BRKINT, CS8, ECHO, ICANON, ICRNL, IEXTEN, INPCK, ISIG, ISTRIP, 118 | IXON, /* OPOST, */ VMIN, VTIME}; 119 | if !self.stdin_isatty { 120 | try!(Err(nix::Error::from_errno(ENOTTY))); 121 | } 122 | termios::tcgetattr(STDIN_FILENO, &mut orig_term)?; 123 | let mut raw = orig_term; 124 | // disable BREAK interrupt, CR to NL conversion on input, 125 | // input parity check, strip high bit (bit 8), output flow control 126 | raw.c_iflag &= !(BRKINT | ICRNL | INPCK | ISTRIP | IXON); 127 | // we don't want raw output, it turns newlines into straight linefeeds 128 | // raw.c_oflag = raw.c_oflag & !(OPOST); // disable all output processing 129 | raw.c_cflag |= CS8; // character-size mark (8 bits) 130 | // disable echoing, canonical mode, extended input processing and signals 131 | raw.c_lflag &= !(ECHO | ICANON | IEXTEN | ISIG); 132 | raw.c_cc[VMIN] = 1; // One character-at-a-time input 133 | raw.c_cc[VTIME] = 0; // with blocking read 134 | try!(termios::tcsetattr(STDIN_FILENO, termios::TCSADRAIN, &raw)); 135 | Ok(orig_term) 136 | } 137 | 138 | pub fn split(self) -> (PollEvented, PollEvented, PollEvented) { 139 | (self.stdin, self.stdout, self.stderr) 140 | } 141 | } 142 | --------------------------------------------------------------------------------