xion / rofld

Lulz on demand

rofl

Lulz on demand

What?

This is a joint repo for:

• the rofld meme server (src/server)
• the rofl crate which powers it (src/lib)
• [WIP] the roflsh CLI application (src/cli)

Why?

To make memes, not war.

rofld's Issues

`cargo build` always rebuilds some crates needlessly

It is probably be a bug in Cargo but noting it here for posterity.

Rebuilding the library crate always triggers a rebuild of certain dependencies:

$ cargo build -p rofl                                                                                                   
   Compiling unreachable v0.1.1
   Compiling thread_local v0.3.3
   Compiling regex v0.2.2
   Compiling rofl v0.0.1 (file:///home/xion/Code/rofld/src/lib)
    Finished dev [unoptimized + debuginfo] target(s) in 23.69 secs

and more so for the server crate:

$ cargo build -p rofld
   Compiling unreachable v0.1.1
   Compiling thread_local v0.3.3
   Compiling slog-extra v0.1.2
   Compiling regex v0.2.2
   Compiling slog-stream v1.2.1
   Compiling slog-term v1.5.0
   Compiling slog-stdlog v1.1.0
   Compiling slog-envlogger v0.5.0
   Compiling rofl v0.0.1 (file:///home/xion/Code/rofld/src/lib)
   Compiling rofld v0.0.1 (file:///home/xion/Code/rofld/src/server)
    Finished dev [unoptimized + debuginfo] target(s) in 56.76 secs

This persists not only through cargo clean or nuking of Cargo.lock, but also apparently between machines AND systems (observed on OSX and Linux). The deps which are rebuilt needlessly are always the same.

It may have started happening with Rust 1.18 but not completely sure about that. In either case, it adds quite a bit to the already long build time :(

"Shrink" text mode

RIght now the meme text is always line-wrapped with a constant size. Sometimes wrapping is undesirable though, so the other mode to support would be to shrink the text (within reason) until it fits the line.

This would be a new per-caption setting, say:

pub enum Overflow { Wrap, Shrink }

Watch for new templates/fonts

In addition to --preload, --watch would set up an inotify subscription to automatically load & cache any templates/fonts put into relevant folders.

(--watch would not require --preload, but would imply it (for the same arguments) if used without & emit a warning).

Heads-up: UB due to misuse of mem::uninitialized will soon lead to panic

Here, this crate causes UB by "Producing an invalid value". Concretely, it produces a value of type VAlign with mem::uninitialized(), but enums must always be in one of their variants. In the near future the call to mem::uninitialized() will panic to avoid UB, and our crater run determined that this crate will be affected.

mem::uninitialized() is deprecated since Rust 1.39. The intended replacement is MaybeUninit, which tracks the possibility of uninitialized values at the type level to make sure the compiler does not make any false assumptions.

Consider using cargo workspaces over the `cargo` script

Investigate using `unicode-width`

The unicode-width crate determines the character width of Unicode strings, and should most likely be used for the line breaking algo. It's unclear if it can completely help with the clipping/overflowing issue we see sometimes, but it should at least allow to detect the invisible/zero-width characters more robustly.

https://crates.io/crates/unicode-width

Multiple lines of text

Lines of text aren't broken currently, so anything too long will be clipped.

Support animated GIFs

Because obviously.

Make a library

The part that does actual captioning of images is mostly independent from the rest of the binary. It could be made into a library crate and published on crates.io.

Improve line breaking

Basic line breaking is in, but it has the following problems:

• it kinda doesn't support words that are longer than the line (they still get clipped); they should be broken up in some rudimentary way
• it doesn't honor explicit line breaks
• it doesn't preserve sequences of whitespace between words