Provide an API to constify enum variants.

[emilio]

r? @upsuper

[upsuper]

A question: may I do

/// <div rustbindgen constant></div>
eCSSProperty_COUNT,

rather than adding it after? I'm concerned about exceeding 80 chars limitation in Gecko code...

Also, is it possible to apply <div rustbindgen hide></div> to enum item? I think we don't really need the dummy ones at all.

[emilio]

I don't think you can do that because doxygen thinks that kind of comment is a comment for the whole enum and applies them to every following item.

I've added a programmatic API that you could also use from the build script though (see the type_chooser API).

[emilio]

Regarding hide, yeah, we should be able to handle that quite easily, let me move some code around :)

[upsuper]

I guess you can change constify_enum_variant to a more general method and let it return the action for a given enum item?

[emilio]

Heh, was writing that right now :)

What do you think about the last commit?

[upsuper]

Looking at the (previously) last commit, I wonder do we really need to try that hard to add enum variant? I don't see much usefulness from doing so.

I think we can simply not add constified items to enum variants, which should simplify the code logic.

[upsuper]

Oh, ignore my last comment. I suddently realize that you have to add enum variant anyway, because otherwise that constant wouldn't be referring to an enum variant.

[emilio]

@upsuper consider the following:

enum Foo {
    A = 1,
    B = 10, /**< <div rustbindgen constant></div> */
};

If I do that (avoid adding constified items), two things happen.

First, they wouldn't have same type (we'd need to make the const an integer or whatever). Second, rust's optimizations may kick in with disastrous consequences (a la #225).

We could enforce constant to be just used when other enum values are around, but seemed easy enough to support the general case.

[emilio]

Oh, didn't read your other comment (had my browser window open).

[upsuper]

r=me with the nits addressed.

[upsuper]

You can probably use VecDeque instead of Vec for constified_variants, and change the three lines above to something like

while let Some(variant) = iter.next().or_else(|| constified_variants.pop_front()) {
    // ...
}

[upsuper]

The last paragraph as well as the link doesn't seem to be something specific to this field. Probably this is comment which should be added to the Annotation struct.

Also, hide now supports enum variants in addition to types, which should be mentioned in the document of that field.

[emilio]

Nice catches :)

@bors-servo r=upsuper

[bors-servo]

📌 Commit fee7e96 has been approved by upsuper

[bors-servo]

⌛ Testing commit fee7e96 with merge 6bfeae1...

[bors-servo]

☀️ Test successful - status-travis