Made CodeAssembler traits public

[Kixiron]

Closes #231

[wtfsck]

Build failed, see https://github.com/icedland/iced/runs/4422431957?check_suite_focus=true

[wtfsck]

Build failed.

You've also accidentally committed some binary files.

[Kixiron]

The build error is from missing docs, do you want me to modify the generator to add the docs that go on the assembler methods to the traits (e.g. CodeAssember::mov()) or just ignore them for now?

[wtfsck]

Yes, you can disable all warnings about docs (eg. adding a #![docs(hidden)] will probably fix that)

I noticed you renamed the module. This will possibly cause problems with the docs. It's possible that all the generated methods will be shown first. See docs here where eg. the constructor is at the top of the file (after the module docs) and all the generated methods are at the end.

Is the order still the same or are all generated methods at the top now?

[Kixiron]

It looks to be the same in terms of method layout

[Kixiron]

I'm getting this warning from rustdoc but I'm not sure what version of rust it's from vs. what versions of rust you support, would you like me to fix it?

warning: lint `invalid_html_tags` has been renamed to `rustdoc::invalid_html_tags`
  --> iced-x86\src\lib.rs:13:9
   |
13 | #![warn(invalid_html_tags)]
   |         ^^^^^^^^^^^^^^^^^ help: use the new name: `rustdoc::invalid_html_tags`
   |
   = note: `#[warn(renamed_and_removed_lints)]` on by default

[wtfsck]

You can ignore that warning. We need to support rust 1.48.0 and it doesn't support the new rustdoc warning name.

[Kixiron]

I added trait documentation to the generator and ran it, but it seems to have changed a bunch of files from LF to CRLF, do you know how to fix that?

Edit: I think this is being caused by Environment.NewLine which is defaulting to \r\n since I'm on windows

[wtfsck]

Docs aren't needed, a simple doc(hidden) at the top should be enough.

Maybe you didn't enable the git option to use default line endings, I think it just checks out LF line endings when it should be checking out files with CRLF line endings. You should probably set core.autocrlf to true, see https://git-scm.com/book/en/v2/Customizing-Git-Git-Configuration . Reset the files and re-run the generator and it will hopefully work.

[wtfsck]

Did it compile without any warnings/errors?

[Kixiron]

Clippy gives missing inline warnings for all of the trait methods

warning: missing `#[inline]` for a method
     --> iced-x86\src\code_asm\fn_asm_impl.rs:74231:2
      |
74231 | /     fn vsqrtpd(&mut self, op0: AsmRegisterYmm, op1: AsmMemoryOperand) -> Result<(), IcedError> {
74232 | |         let code = if op1.is_broadcast() {
74233 | |             Code::EVEX_Vsqrtpd_ymm_k1z_ymmm256b64
74234 | |         } else if self.instruction_prefer_vex() {
...     |
74239 | |         self.add_instr_with_state(Instruction::with2(code, op0.register(), op1.to_memory_operand(self.bitness()))?, op0.state().merge(op1...
74240 | |     }
      | |_____^
      |
      = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#missing_inline_in_public_items

A bunch of tests have redundant closures

warning: redundant closure
   --> iced-x86\src\formatter\nasm\tests\mod.rs:127:57
    |
127 |     formatter_test_nondec(64, "Nasm", "NonDec_MemMinimum", || create_memminimum());
    |                                                            ^^^^^^^^^^^^^^^^^^^^^^ help: replace the closure with the function itself: `create_memminimum`
    |
    = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#redundant_closure

warning: `iced-x86` (lib test) generated 183 warnings

But my changes didn't cause these, what do you want me to do?

[wtfsck]

Try this (code_asm.rs)

+#[allow(missing_docs)]
+#[allow(clippy::missing_errors_doc)]
+pub mod asm_traits;
 mod code_asm_methods;
+#[allow(clippy::missing_inline_in_public_items)]
 mod fn_asm_impl;
 mod fn_asm_pub;
-mod fn_asm_traits;
 mod mem;
 mod op_state;
 mod reg;

Note that I removed doc(hidden) and added allow(missing_docs)

[wtfsck]

.

[Kixiron]

Fixed all of the clippy warnings, should be good to go

[wtfsck]

Can you undo the last commit? I fixed those earlier already, see #239

Assuming everything builds (after removing the last commit), I'll merge this PR! Thanks!

[wtfsck]

Thanks, merged!