[llvm-dev] Refactor BitcodeWriter into classes?

Mehdi Amini via llvm-dev llvm-dev at lists.llvm.org
Thu Apr 21 11:41:36 PDT 2016

> On Apr 21, 2016, at 11:25 AM, Teresa Johnson <tejohnson at google.com> wrote:
> I am currently making some BitcodeWriter changes that involve some refactoring, and am thinking for the Nth time that it would be much nicer to have a class instead of passing around a long list of parameters. I am thinking of biting the bullet and doing that - any objections? 

In general I'm worried about having single gigantic class that keep many data members, this goes against https://en.wikipedia.org/wiki/Single_responsibility_principle and makes it hard to track what is initialized, where, and under which condition (basically one of the reason why global variables are not welcome). The code is almost always easier to understand with small separated components (yes many places are drifting a lot in LLVM...).

Not to say that it can't be done, just that it requires a lot of care.



> I assume the reason why there is no existing class wrapping the bitcode writing process is just legacy code and nothing else?
> It seems like at the least a simple class could hold the common elements used by the various bitcode writing routines, and I might want to add a specialized class to manage the ThinLTO combined index file generation.
> Thanks,
> Teresa
> -- 
> Teresa Johnson |	 Software Engineer |	 tejohnson at google.com <mailto:tejohnson at google.com> |	 408-460-2413

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.llvm.org/pipermail/llvm-dev/attachments/20160421/22955465/attachment.html>

More information about the llvm-dev mailing list